Playbooks
APIs for managing playbooks
Add an ad-hoc task to a running playbook
Authorizations
AuthorizationstringRequired
Path parameters
investigationIdstringRequired
investigation ID
Body
addAfterbooleanOptional
addToSeparateBranchbooleanOptional
automationScriptstringOptional
descriptionstringOptional
namestringOptional
neighborInvPBTaskIdstringOptional
playbookIdstringOptional
separateContextbooleanOptional
tagsstring[]Optional
typestringOptional
TaskType is the Task in the playbook context as a node
Responses
200
InvestigationPlaybook
application/json
InvestigationPlaybook is a wrapper for a linked list of Playbook tasks
DirtybooleanOptional
ReplacedPlaybookbooleanOptional
Indicate whether this playbook has new history during this session
ShardIDinteger · int64Optional
UpdatedOperatorIDsbooleanOptional
allReadbooleanOptional
allReadWritebooleanOptional
autoExtractingbooleanOptional
cacheVersninteger · int64Optional
commentstringOptional
createdstring · date-timeOptional
dbotCreatedBystringOptional
Who has created this event - relevant only for manual incidents
hasRolebooleanOptional
Internal field to make queries on role faster
idstringOptional
incidentCreateDatestring · date-timeOptional
Incident create date
indexNamestringOptional
investigationIdstringOptional
isTIMbooleanOptional
modifiedstring · date-timeOptional
namestringOptional
numericIdinteger · int64Optional
playbookIdstringOptional
previousAllReadbooleanOptional
previousAllReadWritebooleanOptional
previousRolesstring[]Optional
Do not change this field manually
primaryTerminteger · int64Optional
quietbooleanOptional
recoveryAttemptsinteger · int64Optional
rolesstring[]Optional
The role assigned to this investigation
sequenceNumberinteger · int64Optional
serverIdstringOptional
Holds the ID of the responsible cluster app server
sizeInBytesinteger · int64Optional
sortValuesstring[]Optional
startDatestring · date-timeOptional
startTaskIdstringOptional
FirstTask is the root task of the playbook
statestringOptional
InvestigationPlaybookState indicates the state of the running playbook
syncHashstringOptional
versioninteger · int64Optional
viewobject · PlaybookViewOptional
PlaybookView represents the view in client of playbook graph
xsoarHasReadOnlyRolebooleanOptional
xsoarPreviousReadOnlyRolesstring[]Optional
xsoarReadOnlyRolesstring[]Optional
post/inv-playbook/task/add/{investigationId}
POST /inv-playbook/task/add/{investigationId} HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1015
{
"addAfter": true,
"addToSeparateBranch": true,
"automationScript": "text",
"description": "text",
"loop": {
"brand": "text",
"builtinCondition": [
[
{
"ignoreCase": true,
"left": {
"isContext": true,
"value": "[Circular Reference]"
},
"operator": "text",
"right": {
"isContext": true,
"value": "[Circular Reference]"
},
"type": "text"
}
]
],
"exitCondition": "text",
"forEach": true,
"isCommand": true,
"max": 1,
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
},
"scriptId": "text",
"scriptName": "text",
"wait": 1
},
"name": "text",
"neighborInvPBTaskId": "text",
"playbookId": "text",
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
},
"separateContext": true,
"tags": [
"text"
],
"type": "text"
}200
InvestigationPlaybook
{
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
],
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": [
{
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"autoExtracting": true,
"comment": "text",
"inputs": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
],
"investigationId": "text",
"isTIM": true,
"name": "text",
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"quiet": true,
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
]
},
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"tasks": {
"ANY_ADDITIONAL_PROPERTY": {
"Reopen": true,
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"assignee": "text",
"assigneeSet": true,
"blockingTasks": [
"text"
],
"calculatedDescription": "text",
"calculatedTaskName": "text",
"comments": true,
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"conditions": [
"[Circular Reference]"
],
"continueOnError": true,
"continueOnErrorType": "text",
"defaultAssignee": "text",
"defaultAssigneeComplex": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"defaultReminder": 1,
"doNotSaveTaskHistory": true,
"dueDate": "2026-01-01T00:00:00.000Z",
"dueDateDuration": 1,
"dueDateDurationUnit": 1,
"dueDateSet": true,
"entries": [
"text"
],
"evidenceData": {
"customFields": "[Circular Reference]",
"description": "[Circular Reference]",
"occurred": "[Circular Reference]",
"tags": "[Circular Reference]"
},
"executionCount": 1,
"externalFormUseAuth": true,
"fieldMapping": [
"[Circular Reference]"
],
"forEachIndex": 1,
"forEachInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{}
]
},
"form": {
"description": "text",
"expired": true,
"questions": "[Circular Reference]",
"sender": "text",
"title": "text",
"totalAnswers": 1
},
"formDisplay": {
"bodyBackgroundColor": "text",
"bodyFontColor": "text",
"headerBackgroundColor": "text",
"headerFontColor": "text",
"isExternalRtl": true,
"sender": "text",
"submitButtonBackgroundColor": "text",
"submitButtonFontColor": "text",
"submitText": "text"
},
"hasErrorEntries": true,
"id": "text",
"ignoreWorker": true,
"indent": 1,
"input": "text",
"isAutoSwitchedToQuietMode": true,
"isOverSize": true,
"loop": {
"brand": "text",
"builtinCondition": "[Circular Reference]",
"exitCondition": "text",
"forEach": true,
"isCommand": true,
"max": 1,
"scriptArguments": "[Circular Reference]",
"scriptId": "text",
"scriptName": "text",
"wait": 1
},
"message": {
"bcc": "[Circular Reference]",
"body": "[Circular Reference]",
"cc": "[Circular Reference]",
"defaultOption": "text",
"format": "text",
"methods": [
"text"
],
"replyOptions": [
"text"
],
"subject": "[Circular Reference]",
"timings": {
"completeAfterReplies": 1,
"completeAfterSLA": true,
"completeAfterV2": true,
"retriesCount": 1,
"retriesInterval": 1
},
"to": "[Circular Reference]"
},
"missingContentItem": "text",
"nextPollingTime": "2026-01-01T00:00:00.000Z",
"nextTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"note": true,
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"parentBlockCount": 1,
"parentPlaybookID": "text",
"patched": true,
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"pollingEntries": [
"text"
],
"pollingTimeoutTime": "2026-01-01T00:00:00.000Z",
"previousTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"quietMode": 1,
"reminder": 1,
"reputationCalc": 1,
"restrictedCompletion": true,
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"separateContext": true,
"skip": true,
"skipUnavailable": true,
"sla": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"slaReminder": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"startDate": "2026-01-01T00:00:00.000Z",
"startedExecutingHarmfulScript": true,
"state": "text",
"subPlaybook": {
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": "[Circular Reference]",
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": "[Circular Reference]",
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": "[Circular Reference]",
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": "[Circular Reference]",
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
},
"task": {
"brand": "text",
"cacheVersn": 1,
"clonedFrom": "text",
"comment": "text",
"conditions": [
"text"
],
"created": "2026-01-01T00:00:00.000Z",
"description": "text",
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"isCommand": true,
"isLocked": true,
"isTitleTask": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"playbookId": "text",
"playbookName": "text",
"primaryTerm": 1,
"scriptId": "text",
"sequenceNumber": 1,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"tags": [
"text"
],
"type": "text",
"version": 1
},
"taskCompleteData": [
{
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"calculatedDescription": "text",
"calculatedTaskName": "text",
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"entries": [
"text"
],
"hasErrorEntries": true,
"input": "text",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"startDate": "2026-01-01T00:00:00.000Z",
"state": "text",
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
],
"taskDebug": {
"breakpointCondition": "[Circular Reference]",
"inputOverrides": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"isMarkedWithBreakpoint": true,
"isMarkedWithSkip": true,
"outputOverrides": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"shouldOverrideDebugInfo": true,
"skipConditionOverrideTo": "text",
"taskOriginalId": "text"
},
"taskId": "text",
"taskSize": 1,
"timerTriggers": [
{
"action": "text",
"fieldName": "text"
}
],
"timesPolled": 1,
"type": "text",
"view": {},
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
},
"view": {}
}
],
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
]
},
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": {
"ANY_ADDITIONAL_PROPERTY": {
"Reopen": true,
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"assignee": "text",
"assigneeSet": true,
"blockingTasks": [
"text"
],
"calculatedDescription": "text",
"calculatedTaskName": "text",
"comments": true,
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"conditions": [
{
"condition": [
"[Circular Reference]"
],
"label": "text"
}
],
"continueOnError": true,
"continueOnErrorType": "text",
"defaultAssignee": "text",
"defaultAssigneeComplex": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"defaultReminder": 1,
"doNotSaveTaskHistory": true,
"dueDate": "2026-01-01T00:00:00.000Z",
"dueDateDuration": 1,
"dueDateDurationUnit": 1,
"dueDateSet": true,
"entries": [
"text"
],
"evidenceData": {
"customFields": "[Circular Reference]",
"description": "[Circular Reference]",
"occurred": "[Circular Reference]",
"tags": "[Circular Reference]"
},
"executionCount": 1,
"externalFormUseAuth": true,
"fieldMapping": [
{
"fieldId": "text",
"output": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
}
}
],
"forEachIndex": 1,
"forEachInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{}
]
},
"form": {
"description": "text",
"expired": true,
"questions": "[Circular Reference]",
"sender": "text",
"title": "text",
"totalAnswers": 1
},
"formDisplay": {
"bodyBackgroundColor": "text",
"bodyFontColor": "text",
"headerBackgroundColor": "text",
"headerFontColor": "text",
"isExternalRtl": true,
"sender": "text",
"submitButtonBackgroundColor": "text",
"submitButtonFontColor": "text",
"submitText": "text"
},
"hasErrorEntries": true,
"id": "text",
"ignoreWorker": true,
"indent": 1,
"input": "text",
"isAutoSwitchedToQuietMode": true,
"isOverSize": true,
"loop": {
"brand": "text",
"builtinCondition": "[Circular Reference]",
"exitCondition": "text",
"forEach": true,
"isCommand": true,
"max": 1,
"scriptArguments": "[Circular Reference]",
"scriptId": "text",
"scriptName": "text",
"wait": 1
},
"message": {
"bcc": "[Circular Reference]",
"body": "[Circular Reference]",
"cc": "[Circular Reference]",
"defaultOption": "text",
"format": "text",
"methods": [
"text"
],
"replyOptions": [
"text"
],
"subject": "[Circular Reference]",
"timings": {
"completeAfterReplies": 1,
"completeAfterSLA": true,
"completeAfterV2": true,
"retriesCount": 1,
"retriesInterval": 1
},
"to": "[Circular Reference]"
},
"missingContentItem": "text",
"nextPollingTime": "2026-01-01T00:00:00.000Z",
"nextTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"note": true,
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"parentBlockCount": 1,
"parentPlaybookID": "text",
"patched": true,
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"pollingEntries": [
"text"
],
"pollingTimeoutTime": "2026-01-01T00:00:00.000Z",
"previousTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"quietMode": 1,
"reminder": 1,
"reputationCalc": 1,
"restrictedCompletion": true,
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"separateContext": true,
"skip": true,
"skipUnavailable": true,
"sla": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"slaReminder": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"startDate": "2026-01-01T00:00:00.000Z",
"startedExecutingHarmfulScript": true,
"state": "text",
"subPlaybook": {
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": "[Circular Reference]",
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": "[Circular Reference]",
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": "[Circular Reference]",
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": "[Circular Reference]",
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
},
"task": {
"brand": "text",
"cacheVersn": 1,
"clonedFrom": "text",
"comment": "text",
"conditions": [
"text"
],
"created": "2026-01-01T00:00:00.000Z",
"description": "text",
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"isCommand": true,
"isLocked": true,
"isTitleTask": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"playbookId": "text",
"playbookName": "text",
"primaryTerm": 1,
"scriptId": "text",
"sequenceNumber": 1,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"tags": [
"text"
],
"type": "text",
"version": 1
},
"taskCompleteData": [
{
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"calculatedDescription": "text",
"calculatedTaskName": "text",
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"entries": [
"text"
],
"hasErrorEntries": true,
"input": "text",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"startDate": "2026-01-01T00:00:00.000Z",
"state": "text",
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
],
"taskDebug": {
"breakpointCondition": "[Circular Reference]",
"inputOverrides": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"isMarkedWithBreakpoint": true,
"isMarkedWithSkip": true,
"outputOverrides": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"shouldOverrideDebugInfo": true,
"skipConditionOverrideTo": "text",
"taskOriginalId": "text"
},
"taskId": "text",
"taskSize": 1,
"timerTriggers": [
{
"action": "text",
"fieldName": "text"
}
],
"timesPolled": 1,
"type": "text",
"view": {},
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
},
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
}Assign a task to an owner
Authorizations
AuthorizationstringRequired
Body
assigneestringOptional
inTaskIDstringOptional
invIdstringOptional
versioninteger · int64Optional
Responses
200
InvestigationPlaybook
application/json
InvestigationPlaybook is a wrapper for a linked list of Playbook tasks
DirtybooleanOptional
ReplacedPlaybookbooleanOptional
Indicate whether this playbook has new history during this session
ShardIDinteger · int64Optional
UpdatedOperatorIDsbooleanOptional
allReadbooleanOptional
allReadWritebooleanOptional
autoExtractingbooleanOptional
cacheVersninteger · int64Optional
commentstringOptional
createdstring · date-timeOptional
dbotCreatedBystringOptional
Who has created this event - relevant only for manual incidents
hasRolebooleanOptional
Internal field to make queries on role faster
idstringOptional
incidentCreateDatestring · date-timeOptional
Incident create date
indexNamestringOptional
investigationIdstringOptional
isTIMbooleanOptional
modifiedstring · date-timeOptional
namestringOptional
numericIdinteger · int64Optional
playbookIdstringOptional
previousAllReadbooleanOptional
previousAllReadWritebooleanOptional
previousRolesstring[]Optional
Do not change this field manually
primaryTerminteger · int64Optional
quietbooleanOptional
recoveryAttemptsinteger · int64Optional
rolesstring[]Optional
The role assigned to this investigation
sequenceNumberinteger · int64Optional
serverIdstringOptional
Holds the ID of the responsible cluster app server
sizeInBytesinteger · int64Optional
sortValuesstring[]Optional
startDatestring · date-timeOptional
startTaskIdstringOptional
FirstTask is the root task of the playbook
statestringOptional
InvestigationPlaybookState indicates the state of the running playbook
syncHashstringOptional
versioninteger · int64Optional
viewobject · PlaybookViewOptional
PlaybookView represents the view in client of playbook graph
xsoarHasReadOnlyRolebooleanOptional
xsoarPreviousReadOnlyRolesstring[]Optional
xsoarReadOnlyRolesstring[]Optional
post/inv-playbook/task/assign
POST /inv-playbook/task/assign HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 64
{
"assignee": "text",
"inTaskID": "text",
"invId": "text",
"version": 1
}200
InvestigationPlaybook
{
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
],
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": [
{
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"autoExtracting": true,
"comment": "text",
"inputs": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
],
"investigationId": "text",
"isTIM": true,
"name": "text",
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"quiet": true,
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
]
},
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"tasks": {
"ANY_ADDITIONAL_PROPERTY": {
"Reopen": true,
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"assignee": "text",
"assigneeSet": true,
"blockingTasks": [
"text"
],
"calculatedDescription": "text",
"calculatedTaskName": "text",
"comments": true,
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"conditions": [
"[Circular Reference]"
],
"continueOnError": true,
"continueOnErrorType": "text",
"defaultAssignee": "text",
"defaultAssigneeComplex": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"defaultReminder": 1,
"doNotSaveTaskHistory": true,
"dueDate": "2026-01-01T00:00:00.000Z",
"dueDateDuration": 1,
"dueDateDurationUnit": 1,
"dueDateSet": true,
"entries": [
"text"
],
"evidenceData": {
"customFields": "[Circular Reference]",
"description": "[Circular Reference]",
"occurred": "[Circular Reference]",
"tags": "[Circular Reference]"
},
"executionCount": 1,
"externalFormUseAuth": true,
"fieldMapping": [
"[Circular Reference]"
],
"forEachIndex": 1,
"forEachInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{}
]
},
"form": {
"description": "text",
"expired": true,
"questions": "[Circular Reference]",
"sender": "text",
"title": "text",
"totalAnswers": 1
},
"formDisplay": {
"bodyBackgroundColor": "text",
"bodyFontColor": "text",
"headerBackgroundColor": "text",
"headerFontColor": "text",
"isExternalRtl": true,
"sender": "text",
"submitButtonBackgroundColor": "text",
"submitButtonFontColor": "text",
"submitText": "text"
},
"hasErrorEntries": true,
"id": "text",
"ignoreWorker": true,
"indent": 1,
"input": "text",
"isAutoSwitchedToQuietMode": true,
"isOverSize": true,
"loop": {
"brand": "text",
"builtinCondition": "[Circular Reference]",
"exitCondition": "text",
"forEach": true,
"isCommand": true,
"max": 1,
"scriptArguments": "[Circular Reference]",
"scriptId": "text",
"scriptName": "text",
"wait": 1
},
"message": {
"bcc": "[Circular Reference]",
"body": "[Circular Reference]",
"cc": "[Circular Reference]",
"defaultOption": "text",
"format": "text",
"methods": [
"text"
],
"replyOptions": [
"text"
],
"subject": "[Circular Reference]",
"timings": {
"completeAfterReplies": 1,
"completeAfterSLA": true,
"completeAfterV2": true,
"retriesCount": 1,
"retriesInterval": 1
},
"to": "[Circular Reference]"
},
"missingContentItem": "text",
"nextPollingTime": "2026-01-01T00:00:00.000Z",
"nextTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"note": true,
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"parentBlockCount": 1,
"parentPlaybookID": "text",
"patched": true,
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"pollingEntries": [
"text"
],
"pollingTimeoutTime": "2026-01-01T00:00:00.000Z",
"previousTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"quietMode": 1,
"reminder": 1,
"reputationCalc": 1,
"restrictedCompletion": true,
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"separateContext": true,
"skip": true,
"skipUnavailable": true,
"sla": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"slaReminder": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"startDate": "2026-01-01T00:00:00.000Z",
"startedExecutingHarmfulScript": true,
"state": "text",
"subPlaybook": {
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": "[Circular Reference]",
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": "[Circular Reference]",
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": "[Circular Reference]",
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": "[Circular Reference]",
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
},
"task": {
"brand": "text",
"cacheVersn": 1,
"clonedFrom": "text",
"comment": "text",
"conditions": [
"text"
],
"created": "2026-01-01T00:00:00.000Z",
"description": "text",
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"isCommand": true,
"isLocked": true,
"isTitleTask": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"playbookId": "text",
"playbookName": "text",
"primaryTerm": 1,
"scriptId": "text",
"sequenceNumber": 1,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"tags": [
"text"
],
"type": "text",
"version": 1
},
"taskCompleteData": [
{
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"calculatedDescription": "text",
"calculatedTaskName": "text",
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"entries": [
"text"
],
"hasErrorEntries": true,
"input": "text",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"startDate": "2026-01-01T00:00:00.000Z",
"state": "text",
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
],
"taskDebug": {
"breakpointCondition": "[Circular Reference]",
"inputOverrides": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"isMarkedWithBreakpoint": true,
"isMarkedWithSkip": true,
"outputOverrides": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"shouldOverrideDebugInfo": true,
"skipConditionOverrideTo": "text",
"taskOriginalId": "text"
},
"taskId": "text",
"taskSize": 1,
"timerTriggers": [
{
"action": "text",
"fieldName": "text"
}
],
"timesPolled": 1,
"type": "text",
"view": {},
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
},
"view": {}
}
],
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
]
},
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": {
"ANY_ADDITIONAL_PROPERTY": {
"Reopen": true,
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"assignee": "text",
"assigneeSet": true,
"blockingTasks": [
"text"
],
"calculatedDescription": "text",
"calculatedTaskName": "text",
"comments": true,
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"conditions": [
{
"condition": [
"[Circular Reference]"
],
"label": "text"
}
],
"continueOnError": true,
"continueOnErrorType": "text",
"defaultAssignee": "text",
"defaultAssigneeComplex": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"defaultReminder": 1,
"doNotSaveTaskHistory": true,
"dueDate": "2026-01-01T00:00:00.000Z",
"dueDateDuration": 1,
"dueDateDurationUnit": 1,
"dueDateSet": true,
"entries": [
"text"
],
"evidenceData": {
"customFields": "[Circular Reference]",
"description": "[Circular Reference]",
"occurred": "[Circular Reference]",
"tags": "[Circular Reference]"
},
"executionCount": 1,
"externalFormUseAuth": true,
"fieldMapping": [
{
"fieldId": "text",
"output": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
}
}
],
"forEachIndex": 1,
"forEachInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{}
]
},
"form": {
"description": "text",
"expired": true,
"questions": "[Circular Reference]",
"sender": "text",
"title": "text",
"totalAnswers": 1
},
"formDisplay": {
"bodyBackgroundColor": "text",
"bodyFontColor": "text",
"headerBackgroundColor": "text",
"headerFontColor": "text",
"isExternalRtl": true,
"sender": "text",
"submitButtonBackgroundColor": "text",
"submitButtonFontColor": "text",
"submitText": "text"
},
"hasErrorEntries": true,
"id": "text",
"ignoreWorker": true,
"indent": 1,
"input": "text",
"isAutoSwitchedToQuietMode": true,
"isOverSize": true,
"loop": {
"brand": "text",
"builtinCondition": "[Circular Reference]",
"exitCondition": "text",
"forEach": true,
"isCommand": true,
"max": 1,
"scriptArguments": "[Circular Reference]",
"scriptId": "text",
"scriptName": "text",
"wait": 1
},
"message": {
"bcc": "[Circular Reference]",
"body": "[Circular Reference]",
"cc": "[Circular Reference]",
"defaultOption": "text",
"format": "text",
"methods": [
"text"
],
"replyOptions": [
"text"
],
"subject": "[Circular Reference]",
"timings": {
"completeAfterReplies": 1,
"completeAfterSLA": true,
"completeAfterV2": true,
"retriesCount": 1,
"retriesInterval": 1
},
"to": "[Circular Reference]"
},
"missingContentItem": "text",
"nextPollingTime": "2026-01-01T00:00:00.000Z",
"nextTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"note": true,
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"parentBlockCount": 1,
"parentPlaybookID": "text",
"patched": true,
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"pollingEntries": [
"text"
],
"pollingTimeoutTime": "2026-01-01T00:00:00.000Z",
"previousTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"quietMode": 1,
"reminder": 1,
"reputationCalc": 1,
"restrictedCompletion": true,
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"separateContext": true,
"skip": true,
"skipUnavailable": true,
"sla": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"slaReminder": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"startDate": "2026-01-01T00:00:00.000Z",
"startedExecutingHarmfulScript": true,
"state": "text",
"subPlaybook": {
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": "[Circular Reference]",
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": "[Circular Reference]",
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": "[Circular Reference]",
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": "[Circular Reference]",
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
},
"task": {
"brand": "text",
"cacheVersn": 1,
"clonedFrom": "text",
"comment": "text",
"conditions": [
"text"
],
"created": "2026-01-01T00:00:00.000Z",
"description": "text",
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"isCommand": true,
"isLocked": true,
"isTitleTask": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"playbookId": "text",
"playbookName": "text",
"primaryTerm": 1,
"scriptId": "text",
"sequenceNumber": 1,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"tags": [
"text"
],
"type": "text",
"version": 1
},
"taskCompleteData": [
{
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"calculatedDescription": "text",
"calculatedTaskName": "text",
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"entries": [
"text"
],
"hasErrorEntries": true,
"input": "text",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"startDate": "2026-01-01T00:00:00.000Z",
"state": "text",
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
],
"taskDebug": {
"breakpointCondition": "[Circular Reference]",
"inputOverrides": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"isMarkedWithBreakpoint": true,
"isMarkedWithSkip": true,
"outputOverrides": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"shouldOverrideDebugInfo": true,
"skipConditionOverrideTo": "text",
"taskOriginalId": "text"
},
"taskId": "text",
"taskSize": 1,
"timerTriggers": [
{
"action": "text",
"fieldName": "text"
}
],
"timesPolled": 1,
"type": "text",
"view": {},
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
},
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
}Complete a task with a file attachment Deprecated - use "/v2/inv-playbook/task/complete"
Authorizations
AuthorizationstringRequired
Body
investigationIdstringOptional
investigation ID
fileNamestringOptional
file name
fileCommentstringOptional
file comment
taskIdstringOptional
Task Id
taskInputstringOptional
task input
versionstringOptional
Version
filestringOptional
file
Responses
200
InvestigationPlaybook
application/json
InvestigationPlaybook is a wrapper for a linked list of Playbook tasks
DirtybooleanOptional
ReplacedPlaybookbooleanOptional
Indicate whether this playbook has new history during this session
ShardIDinteger · int64Optional
UpdatedOperatorIDsbooleanOptional
allReadbooleanOptional
allReadWritebooleanOptional
autoExtractingbooleanOptional
cacheVersninteger · int64Optional
commentstringOptional
createdstring · date-timeOptional
dbotCreatedBystringOptional
Who has created this event - relevant only for manual incidents
hasRolebooleanOptional
Internal field to make queries on role faster
idstringOptional
incidentCreateDatestring · date-timeOptional
Incident create date
indexNamestringOptional
investigationIdstringOptional
isTIMbooleanOptional
modifiedstring · date-timeOptional
namestringOptional
numericIdinteger · int64Optional
playbookIdstringOptional
previousAllReadbooleanOptional
previousAllReadWritebooleanOptional
previousRolesstring[]Optional
Do not change this field manually
primaryTerminteger · int64Optional
quietbooleanOptional
recoveryAttemptsinteger · int64Optional
rolesstring[]Optional
The role assigned to this investigation
sequenceNumberinteger · int64Optional
serverIdstringOptional
Holds the ID of the responsible cluster app server
sizeInBytesinteger · int64Optional
sortValuesstring[]Optional
startDatestring · date-timeOptional
startTaskIdstringOptional
FirstTask is the root task of the playbook
statestringOptional
InvestigationPlaybookState indicates the state of the running playbook
syncHashstringOptional
versioninteger · int64Optional
viewobject · PlaybookViewOptional
PlaybookView represents the view in client of playbook graph
xsoarHasReadOnlyRolebooleanOptional
xsoarPreviousReadOnlyRolesstring[]Optional
xsoarReadOnlyRolesstring[]Optional
post/inv-playbook/task/complete
POST /inv-playbook/task/complete HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 131
{
"investigationId": "text",
"fileName": "text",
"fileComment": "text",
"taskId": "text",
"taskInput": "text",
"version": "text",
"file": "text"
}200
InvestigationPlaybook
{
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
],
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": [
{
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"autoExtracting": true,
"comment": "text",
"inputs": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
],
"investigationId": "text",
"isTIM": true,
"name": "text",
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"quiet": true,
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
]
},
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"tasks": {
"ANY_ADDITIONAL_PROPERTY": {
"Reopen": true,
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"assignee": "text",
"assigneeSet": true,
"blockingTasks": [
"text"
],
"calculatedDescription": "text",
"calculatedTaskName": "text",
"comments": true,
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"conditions": [
"[Circular Reference]"
],
"continueOnError": true,
"continueOnErrorType": "text",
"defaultAssignee": "text",
"defaultAssigneeComplex": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"defaultReminder": 1,
"doNotSaveTaskHistory": true,
"dueDate": "2026-01-01T00:00:00.000Z",
"dueDateDuration": 1,
"dueDateDurationUnit": 1,
"dueDateSet": true,
"entries": [
"text"
],
"evidenceData": {
"customFields": "[Circular Reference]",
"description": "[Circular Reference]",
"occurred": "[Circular Reference]",
"tags": "[Circular Reference]"
},
"executionCount": 1,
"externalFormUseAuth": true,
"fieldMapping": [
"[Circular Reference]"
],
"forEachIndex": 1,
"forEachInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{}
]
},
"form": {
"description": "text",
"expired": true,
"questions": "[Circular Reference]",
"sender": "text",
"title": "text",
"totalAnswers": 1
},
"formDisplay": {
"bodyBackgroundColor": "text",
"bodyFontColor": "text",
"headerBackgroundColor": "text",
"headerFontColor": "text",
"isExternalRtl": true,
"sender": "text",
"submitButtonBackgroundColor": "text",
"submitButtonFontColor": "text",
"submitText": "text"
},
"hasErrorEntries": true,
"id": "text",
"ignoreWorker": true,
"indent": 1,
"input": "text",
"isAutoSwitchedToQuietMode": true,
"isOverSize": true,
"loop": {
"brand": "text",
"builtinCondition": "[Circular Reference]",
"exitCondition": "text",
"forEach": true,
"isCommand": true,
"max": 1,
"scriptArguments": "[Circular Reference]",
"scriptId": "text",
"scriptName": "text",
"wait": 1
},
"message": {
"bcc": "[Circular Reference]",
"body": "[Circular Reference]",
"cc": "[Circular Reference]",
"defaultOption": "text",
"format": "text",
"methods": [
"text"
],
"replyOptions": [
"text"
],
"subject": "[Circular Reference]",
"timings": {
"completeAfterReplies": 1,
"completeAfterSLA": true,
"completeAfterV2": true,
"retriesCount": 1,
"retriesInterval": 1
},
"to": "[Circular Reference]"
},
"missingContentItem": "text",
"nextPollingTime": "2026-01-01T00:00:00.000Z",
"nextTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"note": true,
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"parentBlockCount": 1,
"parentPlaybookID": "text",
"patched": true,
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"pollingEntries": [
"text"
],
"pollingTimeoutTime": "2026-01-01T00:00:00.000Z",
"previousTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"quietMode": 1,
"reminder": 1,
"reputationCalc": 1,
"restrictedCompletion": true,
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"separateContext": true,
"skip": true,
"skipUnavailable": true,
"sla": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"slaReminder": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"startDate": "2026-01-01T00:00:00.000Z",
"startedExecutingHarmfulScript": true,
"state": "text",
"subPlaybook": {
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": "[Circular Reference]",
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": "[Circular Reference]",
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": "[Circular Reference]",
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": "[Circular Reference]",
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
},
"task": {
"brand": "text",
"cacheVersn": 1,
"clonedFrom": "text",
"comment": "text",
"conditions": [
"text"
],
"created": "2026-01-01T00:00:00.000Z",
"description": "text",
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"isCommand": true,
"isLocked": true,
"isTitleTask": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"playbookId": "text",
"playbookName": "text",
"primaryTerm": 1,
"scriptId": "text",
"sequenceNumber": 1,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"tags": [
"text"
],
"type": "text",
"version": 1
},
"taskCompleteData": [
{
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"calculatedDescription": "text",
"calculatedTaskName": "text",
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"entries": [
"text"
],
"hasErrorEntries": true,
"input": "text",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"startDate": "2026-01-01T00:00:00.000Z",
"state": "text",
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
],
"taskDebug": {
"breakpointCondition": "[Circular Reference]",
"inputOverrides": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"isMarkedWithBreakpoint": true,
"isMarkedWithSkip": true,
"outputOverrides": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"shouldOverrideDebugInfo": true,
"skipConditionOverrideTo": "text",
"taskOriginalId": "text"
},
"taskId": "text",
"taskSize": 1,
"timerTriggers": [
{
"action": "text",
"fieldName": "text"
}
],
"timesPolled": 1,
"type": "text",
"view": {},
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
},
"view": {}
}
],
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
]
},
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": {
"ANY_ADDITIONAL_PROPERTY": {
"Reopen": true,
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"assignee": "text",
"assigneeSet": true,
"blockingTasks": [
"text"
],
"calculatedDescription": "text",
"calculatedTaskName": "text",
"comments": true,
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"conditions": [
{
"condition": [
"[Circular Reference]"
],
"label": "text"
}
],
"continueOnError": true,
"continueOnErrorType": "text",
"defaultAssignee": "text",
"defaultAssigneeComplex": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"defaultReminder": 1,
"doNotSaveTaskHistory": true,
"dueDate": "2026-01-01T00:00:00.000Z",
"dueDateDuration": 1,
"dueDateDurationUnit": 1,
"dueDateSet": true,
"entries": [
"text"
],
"evidenceData": {
"customFields": "[Circular Reference]",
"description": "[Circular Reference]",
"occurred": "[Circular Reference]",
"tags": "[Circular Reference]"
},
"executionCount": 1,
"externalFormUseAuth": true,
"fieldMapping": [
{
"fieldId": "text",
"output": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
}
}
],
"forEachIndex": 1,
"forEachInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{}
]
},
"form": {
"description": "text",
"expired": true,
"questions": "[Circular Reference]",
"sender": "text",
"title": "text",
"totalAnswers": 1
},
"formDisplay": {
"bodyBackgroundColor": "text",
"bodyFontColor": "text",
"headerBackgroundColor": "text",
"headerFontColor": "text",
"isExternalRtl": true,
"sender": "text",
"submitButtonBackgroundColor": "text",
"submitButtonFontColor": "text",
"submitText": "text"
},
"hasErrorEntries": true,
"id": "text",
"ignoreWorker": true,
"indent": 1,
"input": "text",
"isAutoSwitchedToQuietMode": true,
"isOverSize": true,
"loop": {
"brand": "text",
"builtinCondition": "[Circular Reference]",
"exitCondition": "text",
"forEach": true,
"isCommand": true,
"max": 1,
"scriptArguments": "[Circular Reference]",
"scriptId": "text",
"scriptName": "text",
"wait": 1
},
"message": {
"bcc": "[Circular Reference]",
"body": "[Circular Reference]",
"cc": "[Circular Reference]",
"defaultOption": "text",
"format": "text",
"methods": [
"text"
],
"replyOptions": [
"text"
],
"subject": "[Circular Reference]",
"timings": {
"completeAfterReplies": 1,
"completeAfterSLA": true,
"completeAfterV2": true,
"retriesCount": 1,
"retriesInterval": 1
},
"to": "[Circular Reference]"
},
"missingContentItem": "text",
"nextPollingTime": "2026-01-01T00:00:00.000Z",
"nextTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"note": true,
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"parentBlockCount": 1,
"parentPlaybookID": "text",
"patched": true,
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"pollingEntries": [
"text"
],
"pollingTimeoutTime": "2026-01-01T00:00:00.000Z",
"previousTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"quietMode": 1,
"reminder": 1,
"reputationCalc": 1,
"restrictedCompletion": true,
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"separateContext": true,
"skip": true,
"skipUnavailable": true,
"sla": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"slaReminder": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"startDate": "2026-01-01T00:00:00.000Z",
"startedExecutingHarmfulScript": true,
"state": "text",
"subPlaybook": {
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": "[Circular Reference]",
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": "[Circular Reference]",
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": "[Circular Reference]",
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": "[Circular Reference]",
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
},
"task": {
"brand": "text",
"cacheVersn": 1,
"clonedFrom": "text",
"comment": "text",
"conditions": [
"text"
],
"created": "2026-01-01T00:00:00.000Z",
"description": "text",
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"isCommand": true,
"isLocked": true,
"isTitleTask": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"playbookId": "text",
"playbookName": "text",
"primaryTerm": 1,
"scriptId": "text",
"sequenceNumber": 1,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"tags": [
"text"
],
"type": "text",
"version": 1
},
"taskCompleteData": [
{
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"calculatedDescription": "text",
"calculatedTaskName": "text",
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"entries": [
"text"
],
"hasErrorEntries": true,
"input": "text",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"startDate": "2026-01-01T00:00:00.000Z",
"state": "text",
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
],
"taskDebug": {
"breakpointCondition": "[Circular Reference]",
"inputOverrides": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"isMarkedWithBreakpoint": true,
"isMarkedWithSkip": true,
"outputOverrides": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"shouldOverrideDebugInfo": true,
"skipConditionOverrideTo": "text",
"taskOriginalId": "text"
},
"taskId": "text",
"taskSize": 1,
"timerTriggers": [
{
"action": "text",
"fieldName": "text"
}
],
"timesPolled": 1,
"type": "text",
"view": {},
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
},
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
}Complete a task without a file attachment
Authorizations
AuthorizationstringRequired
Body
commentstringOptional
inTaskIDstringOptional
inputstringOptional
invIdstringOptional
versioninteger · int64Optional
Responses
200
InvestigationPlaybook
application/json
InvestigationPlaybook is a wrapper for a linked list of Playbook tasks
DirtybooleanOptional
ReplacedPlaybookbooleanOptional
Indicate whether this playbook has new history during this session
ShardIDinteger · int64Optional
UpdatedOperatorIDsbooleanOptional
allReadbooleanOptional
allReadWritebooleanOptional
autoExtractingbooleanOptional
cacheVersninteger · int64Optional
commentstringOptional
createdstring · date-timeOptional
dbotCreatedBystringOptional
Who has created this event - relevant only for manual incidents
hasRolebooleanOptional
Internal field to make queries on role faster
idstringOptional
incidentCreateDatestring · date-timeOptional
Incident create date
indexNamestringOptional
investigationIdstringOptional
isTIMbooleanOptional
modifiedstring · date-timeOptional
namestringOptional
numericIdinteger · int64Optional
playbookIdstringOptional
previousAllReadbooleanOptional
previousAllReadWritebooleanOptional
previousRolesstring[]Optional
Do not change this field manually
primaryTerminteger · int64Optional
quietbooleanOptional
recoveryAttemptsinteger · int64Optional
rolesstring[]Optional
The role assigned to this investigation
sequenceNumberinteger · int64Optional
serverIdstringOptional
Holds the ID of the responsible cluster app server
sizeInBytesinteger · int64Optional
sortValuesstring[]Optional
startDatestring · date-timeOptional
startTaskIdstringOptional
FirstTask is the root task of the playbook
statestringOptional
InvestigationPlaybookState indicates the state of the running playbook
syncHashstringOptional
versioninteger · int64Optional
viewobject · PlaybookViewOptional
PlaybookView represents the view in client of playbook graph
xsoarHasReadOnlyRolebooleanOptional
xsoarPreviousReadOnlyRolesstring[]Optional
xsoarReadOnlyRolesstring[]Optional
post/inv-playbook/task/complete/simple
POST /inv-playbook/task/complete/simple HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1250
{
"args": {
"ANY_ADDITIONAL_PROPERTY": {
"complex": {
"accessor": "text",
"filters": [
[
"[Circular Reference]"
]
],
"root": "text",
"transformers": [
{
"args": "[Circular Reference]",
"operator": "text"
}
]
},
"keyValue": [
{
"key": "text",
"value": {
"complex": {
"accessor": "text",
"filters": [
[
"[Circular Reference]"
]
],
"root": "text",
"transformers": [
{
"args": "[Circular Reference]",
"operator": "text"
}
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
}
}
],
"simple": "text"
}
},
"comment": "text",
"conditions": [
{
"condition": [
[
{
"ignoreCase": true,
"left": "[Circular Reference]",
"operator": "text",
"right": "[Circular Reference]",
"type": "text"
}
]
],
"label": "text"
}
],
"inTaskID": "text",
"input": "text",
"invId": "text",
"loopArgs": {
"ANY_ADDITIONAL_PROPERTY": {
"complex": {
"accessor": "text",
"filters": [
[
"[Circular Reference]"
]
],
"root": "text",
"transformers": [
{
"args": "[Circular Reference]",
"operator": "text"
}
]
},
"keyValue": [
{
"key": "text",
"value": {
"complex": {
"accessor": "text",
"filters": [
[
"[Circular Reference]"
]
],
"root": "text",
"transformers": [
{
"args": "[Circular Reference]",
"operator": "text"
}
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
}
}
],
"simple": "text"
}
},
"loopCondition": [
[
{
"ignoreCase": true,
"left": "[Circular Reference]",
"operator": "text",
"right": "[Circular Reference]",
"type": "text"
}
]
],
"version": 1
}200
InvestigationPlaybook
{
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
],
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": [
{
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"autoExtracting": true,
"comment": "text",
"inputs": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
],
"investigationId": "text",
"isTIM": true,
"name": "text",
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"quiet": true,
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
]
},
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"tasks": {
"ANY_ADDITIONAL_PROPERTY": {
"Reopen": true,
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"assignee": "text",
"assigneeSet": true,
"blockingTasks": [
"text"
],
"calculatedDescription": "text",
"calculatedTaskName": "text",
"comments": true,
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"conditions": [
"[Circular Reference]"
],
"continueOnError": true,
"continueOnErrorType": "text",
"defaultAssignee": "text",
"defaultAssigneeComplex": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"defaultReminder": 1,
"doNotSaveTaskHistory": true,
"dueDate": "2026-01-01T00:00:00.000Z",
"dueDateDuration": 1,
"dueDateDurationUnit": 1,
"dueDateSet": true,
"entries": [
"text"
],
"evidenceData": {
"customFields": "[Circular Reference]",
"description": "[Circular Reference]",
"occurred": "[Circular Reference]",
"tags": "[Circular Reference]"
},
"executionCount": 1,
"externalFormUseAuth": true,
"fieldMapping": [
"[Circular Reference]"
],
"forEachIndex": 1,
"forEachInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{}
]
},
"form": {
"description": "text",
"expired": true,
"questions": "[Circular Reference]",
"sender": "text",
"title": "text",
"totalAnswers": 1
},
"formDisplay": {
"bodyBackgroundColor": "text",
"bodyFontColor": "text",
"headerBackgroundColor": "text",
"headerFontColor": "text",
"isExternalRtl": true,
"sender": "text",
"submitButtonBackgroundColor": "text",
"submitButtonFontColor": "text",
"submitText": "text"
},
"hasErrorEntries": true,
"id": "text",
"ignoreWorker": true,
"indent": 1,
"input": "text",
"isAutoSwitchedToQuietMode": true,
"isOverSize": true,
"loop": {
"brand": "text",
"builtinCondition": "[Circular Reference]",
"exitCondition": "text",
"forEach": true,
"isCommand": true,
"max": 1,
"scriptArguments": "[Circular Reference]",
"scriptId": "text",
"scriptName": "text",
"wait": 1
},
"message": {
"bcc": "[Circular Reference]",
"body": "[Circular Reference]",
"cc": "[Circular Reference]",
"defaultOption": "text",
"format": "text",
"methods": [
"text"
],
"replyOptions": [
"text"
],
"subject": "[Circular Reference]",
"timings": {
"completeAfterReplies": 1,
"completeAfterSLA": true,
"completeAfterV2": true,
"retriesCount": 1,
"retriesInterval": 1
},
"to": "[Circular Reference]"
},
"missingContentItem": "text",
"nextPollingTime": "2026-01-01T00:00:00.000Z",
"nextTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"note": true,
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"parentBlockCount": 1,
"parentPlaybookID": "text",
"patched": true,
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"pollingEntries": [
"text"
],
"pollingTimeoutTime": "2026-01-01T00:00:00.000Z",
"previousTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"quietMode": 1,
"reminder": 1,
"reputationCalc": 1,
"restrictedCompletion": true,
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"separateContext": true,
"skip": true,
"skipUnavailable": true,
"sla": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"slaReminder": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"startDate": "2026-01-01T00:00:00.000Z",
"startedExecutingHarmfulScript": true,
"state": "text",
"subPlaybook": {
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": "[Circular Reference]",
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": "[Circular Reference]",
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": "[Circular Reference]",
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": "[Circular Reference]",
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
},
"task": {
"brand": "text",
"cacheVersn": 1,
"clonedFrom": "text",
"comment": "text",
"conditions": [
"text"
],
"created": "2026-01-01T00:00:00.000Z",
"description": "text",
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"isCommand": true,
"isLocked": true,
"isTitleTask": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"playbookId": "text",
"playbookName": "text",
"primaryTerm": 1,
"scriptId": "text",
"sequenceNumber": 1,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"tags": [
"text"
],
"type": "text",
"version": 1
},
"taskCompleteData": [
{
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"calculatedDescription": "text",
"calculatedTaskName": "text",
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"entries": [
"text"
],
"hasErrorEntries": true,
"input": "text",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"startDate": "2026-01-01T00:00:00.000Z",
"state": "text",
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
],
"taskDebug": {
"breakpointCondition": "[Circular Reference]",
"inputOverrides": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"isMarkedWithBreakpoint": true,
"isMarkedWithSkip": true,
"outputOverrides": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"shouldOverrideDebugInfo": true,
"skipConditionOverrideTo": "text",
"taskOriginalId": "text"
},
"taskId": "text",
"taskSize": 1,
"timerTriggers": [
{
"action": "text",
"fieldName": "text"
}
],
"timesPolled": 1,
"type": "text",
"view": {},
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
},
"view": {}
}
],
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
]
},
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": {
"ANY_ADDITIONAL_PROPERTY": {
"Reopen": true,
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"assignee": "text",
"assigneeSet": true,
"blockingTasks": [
"text"
],
"calculatedDescription": "text",
"calculatedTaskName": "text",
"comments": true,
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"conditions": [
{
"condition": [
"[Circular Reference]"
],
"label": "text"
}
],
"continueOnError": true,
"continueOnErrorType": "text",
"defaultAssignee": "text",
"defaultAssigneeComplex": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"defaultReminder": 1,
"doNotSaveTaskHistory": true,
"dueDate": "2026-01-01T00:00:00.000Z",
"dueDateDuration": 1,
"dueDateDurationUnit": 1,
"dueDateSet": true,
"entries": [
"text"
],
"evidenceData": {
"customFields": "[Circular Reference]",
"description": "[Circular Reference]",
"occurred": "[Circular Reference]",
"tags": "[Circular Reference]"
},
"executionCount": 1,
"externalFormUseAuth": true,
"fieldMapping": [
{
"fieldId": "text",
"output": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
}
}
],
"forEachIndex": 1,
"forEachInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{}
]
},
"form": {
"description": "text",
"expired": true,
"questions": "[Circular Reference]",
"sender": "text",
"title": "text",
"totalAnswers": 1
},
"formDisplay": {
"bodyBackgroundColor": "text",
"bodyFontColor": "text",
"headerBackgroundColor": "text",
"headerFontColor": "text",
"isExternalRtl": true,
"sender": "text",
"submitButtonBackgroundColor": "text",
"submitButtonFontColor": "text",
"submitText": "text"
},
"hasErrorEntries": true,
"id": "text",
"ignoreWorker": true,
"indent": 1,
"input": "text",
"isAutoSwitchedToQuietMode": true,
"isOverSize": true,
"loop": {
"brand": "text",
"builtinCondition": "[Circular Reference]",
"exitCondition": "text",
"forEach": true,
"isCommand": true,
"max": 1,
"scriptArguments": "[Circular Reference]",
"scriptId": "text",
"scriptName": "text",
"wait": 1
},
"message": {
"bcc": "[Circular Reference]",
"body": "[Circular Reference]",
"cc": "[Circular Reference]",
"defaultOption": "text",
"format": "text",
"methods": [
"text"
],
"replyOptions": [
"text"
],
"subject": "[Circular Reference]",
"timings": {
"completeAfterReplies": 1,
"completeAfterSLA": true,
"completeAfterV2": true,
"retriesCount": 1,
"retriesInterval": 1
},
"to": "[Circular Reference]"
},
"missingContentItem": "text",
"nextPollingTime": "2026-01-01T00:00:00.000Z",
"nextTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"note": true,
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"parentBlockCount": 1,
"parentPlaybookID": "text",
"patched": true,
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"pollingEntries": [
"text"
],
"pollingTimeoutTime": "2026-01-01T00:00:00.000Z",
"previousTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"quietMode": 1,
"reminder": 1,
"reputationCalc": 1,
"restrictedCompletion": true,
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"separateContext": true,
"skip": true,
"skipUnavailable": true,
"sla": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"slaReminder": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"startDate": "2026-01-01T00:00:00.000Z",
"startedExecutingHarmfulScript": true,
"state": "text",
"subPlaybook": {
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": "[Circular Reference]",
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": "[Circular Reference]",
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": "[Circular Reference]",
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": "[Circular Reference]",
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
},
"task": {
"brand": "text",
"cacheVersn": 1,
"clonedFrom": "text",
"comment": "text",
"conditions": [
"text"
],
"created": "2026-01-01T00:00:00.000Z",
"description": "text",
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"isCommand": true,
"isLocked": true,
"isTitleTask": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"playbookId": "text",
"playbookName": "text",
"primaryTerm": 1,
"scriptId": "text",
"sequenceNumber": 1,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"tags": [
"text"
],
"type": "text",
"version": 1
},
"taskCompleteData": [
{
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"calculatedDescription": "text",
"calculatedTaskName": "text",
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"entries": [
"text"
],
"hasErrorEntries": true,
"input": "text",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"startDate": "2026-01-01T00:00:00.000Z",
"state": "text",
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
],
"taskDebug": {
"breakpointCondition": "[Circular Reference]",
"inputOverrides": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"isMarkedWithBreakpoint": true,
"isMarkedWithSkip": true,
"outputOverrides": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"shouldOverrideDebugInfo": true,
"skipConditionOverrideTo": "text",
"taskOriginalId": "text"
},
"taskId": "text",
"taskSize": 1,
"timerTriggers": [
{
"action": "text",
"fieldName": "text"
}
],
"timesPolled": 1,
"type": "text",
"view": {},
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
},
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
}Delete an ad-hoc task from a running playbook
Authorizations
AuthorizationstringRequired
Path parameters
invPBTaskIdstringRequired
ad-hoc task ID
investigationIdstringRequired
investigation ID
Responses
200
InvestigationPlaybook
application/json
InvestigationPlaybook is a wrapper for a linked list of Playbook tasks
DirtybooleanOptional
ReplacedPlaybookbooleanOptional
Indicate whether this playbook has new history during this session
ShardIDinteger · int64Optional
UpdatedOperatorIDsbooleanOptional
allReadbooleanOptional
allReadWritebooleanOptional
autoExtractingbooleanOptional
cacheVersninteger · int64Optional
commentstringOptional
createdstring · date-timeOptional
dbotCreatedBystringOptional
Who has created this event - relevant only for manual incidents
hasRolebooleanOptional
Internal field to make queries on role faster
idstringOptional
incidentCreateDatestring · date-timeOptional
Incident create date
indexNamestringOptional
investigationIdstringOptional
isTIMbooleanOptional
modifiedstring · date-timeOptional
namestringOptional
numericIdinteger · int64Optional
playbookIdstringOptional
previousAllReadbooleanOptional
previousAllReadWritebooleanOptional
previousRolesstring[]Optional
Do not change this field manually
primaryTerminteger · int64Optional
quietbooleanOptional
recoveryAttemptsinteger · int64Optional
rolesstring[]Optional
The role assigned to this investigation
sequenceNumberinteger · int64Optional
serverIdstringOptional
Holds the ID of the responsible cluster app server
sizeInBytesinteger · int64Optional
sortValuesstring[]Optional
startDatestring · date-timeOptional
startTaskIdstringOptional
FirstTask is the root task of the playbook
statestringOptional
InvestigationPlaybookState indicates the state of the running playbook
syncHashstringOptional
versioninteger · int64Optional
viewobject · PlaybookViewOptional
PlaybookView represents the view in client of playbook graph
xsoarHasReadOnlyRolebooleanOptional
xsoarPreviousReadOnlyRolesstring[]Optional
xsoarReadOnlyRolesstring[]Optional
post/inv-playbook/task/delete/{investigationId}/{invPBTaskId}
POST /inv-playbook/task/delete/{investigationId}/{invPBTaskId} HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Accept: */*
200
InvestigationPlaybook
{
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
],
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": [
{
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"autoExtracting": true,
"comment": "text",
"inputs": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
],
"investigationId": "text",
"isTIM": true,
"name": "text",
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"quiet": true,
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
]
},
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"tasks": {
"ANY_ADDITIONAL_PROPERTY": {
"Reopen": true,
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"assignee": "text",
"assigneeSet": true,
"blockingTasks": [
"text"
],
"calculatedDescription": "text",
"calculatedTaskName": "text",
"comments": true,
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"conditions": [
"[Circular Reference]"
],
"continueOnError": true,
"continueOnErrorType": "text",
"defaultAssignee": "text",
"defaultAssigneeComplex": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"defaultReminder": 1,
"doNotSaveTaskHistory": true,
"dueDate": "2026-01-01T00:00:00.000Z",
"dueDateDuration": 1,
"dueDateDurationUnit": 1,
"dueDateSet": true,
"entries": [
"text"
],
"evidenceData": {
"customFields": "[Circular Reference]",
"description": "[Circular Reference]",
"occurred": "[Circular Reference]",
"tags": "[Circular Reference]"
},
"executionCount": 1,
"externalFormUseAuth": true,
"fieldMapping": [
"[Circular Reference]"
],
"forEachIndex": 1,
"forEachInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{}
]
},
"form": {
"description": "text",
"expired": true,
"questions": "[Circular Reference]",
"sender": "text",
"title": "text",
"totalAnswers": 1
},
"formDisplay": {
"bodyBackgroundColor": "text",
"bodyFontColor": "text",
"headerBackgroundColor": "text",
"headerFontColor": "text",
"isExternalRtl": true,
"sender": "text",
"submitButtonBackgroundColor": "text",
"submitButtonFontColor": "text",
"submitText": "text"
},
"hasErrorEntries": true,
"id": "text",
"ignoreWorker": true,
"indent": 1,
"input": "text",
"isAutoSwitchedToQuietMode": true,
"isOverSize": true,
"loop": {
"brand": "text",
"builtinCondition": "[Circular Reference]",
"exitCondition": "text",
"forEach": true,
"isCommand": true,
"max": 1,
"scriptArguments": "[Circular Reference]",
"scriptId": "text",
"scriptName": "text",
"wait": 1
},
"message": {
"bcc": "[Circular Reference]",
"body": "[Circular Reference]",
"cc": "[Circular Reference]",
"defaultOption": "text",
"format": "text",
"methods": [
"text"
],
"replyOptions": [
"text"
],
"subject": "[Circular Reference]",
"timings": {
"completeAfterReplies": 1,
"completeAfterSLA": true,
"completeAfterV2": true,
"retriesCount": 1,
"retriesInterval": 1
},
"to": "[Circular Reference]"
},
"missingContentItem": "text",
"nextPollingTime": "2026-01-01T00:00:00.000Z",
"nextTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"note": true,
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"parentBlockCount": 1,
"parentPlaybookID": "text",
"patched": true,
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"pollingEntries": [
"text"
],
"pollingTimeoutTime": "2026-01-01T00:00:00.000Z",
"previousTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"quietMode": 1,
"reminder": 1,
"reputationCalc": 1,
"restrictedCompletion": true,
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"separateContext": true,
"skip": true,
"skipUnavailable": true,
"sla": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"slaReminder": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"startDate": "2026-01-01T00:00:00.000Z",
"startedExecutingHarmfulScript": true,
"state": "text",
"subPlaybook": {
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": "[Circular Reference]",
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": "[Circular Reference]",
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": "[Circular Reference]",
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": "[Circular Reference]",
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
},
"task": {
"brand": "text",
"cacheVersn": 1,
"clonedFrom": "text",
"comment": "text",
"conditions": [
"text"
],
"created": "2026-01-01T00:00:00.000Z",
"description": "text",
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"isCommand": true,
"isLocked": true,
"isTitleTask": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"playbookId": "text",
"playbookName": "text",
"primaryTerm": 1,
"scriptId": "text",
"sequenceNumber": 1,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"tags": [
"text"
],
"type": "text",
"version": 1
},
"taskCompleteData": [
{
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"calculatedDescription": "text",
"calculatedTaskName": "text",
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"entries": [
"text"
],
"hasErrorEntries": true,
"input": "text",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"startDate": "2026-01-01T00:00:00.000Z",
"state": "text",
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
],
"taskDebug": {
"breakpointCondition": "[Circular Reference]",
"inputOverrides": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"isMarkedWithBreakpoint": true,
"isMarkedWithSkip": true,
"outputOverrides": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"shouldOverrideDebugInfo": true,
"skipConditionOverrideTo": "text",
"taskOriginalId": "text"
},
"taskId": "text",
"taskSize": 1,
"timerTriggers": [
{
"action": "text",
"fieldName": "text"
}
],
"timesPolled": 1,
"type": "text",
"view": {},
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
},
"view": {}
}
],
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
]
},
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": {
"ANY_ADDITIONAL_PROPERTY": {
"Reopen": true,
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"assignee": "text",
"assigneeSet": true,
"blockingTasks": [
"text"
],
"calculatedDescription": "text",
"calculatedTaskName": "text",
"comments": true,
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"conditions": [
{
"condition": [
"[Circular Reference]"
],
"label": "text"
}
],
"continueOnError": true,
"continueOnErrorType": "text",
"defaultAssignee": "text",
"defaultAssigneeComplex": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"defaultReminder": 1,
"doNotSaveTaskHistory": true,
"dueDate": "2026-01-01T00:00:00.000Z",
"dueDateDuration": 1,
"dueDateDurationUnit": 1,
"dueDateSet": true,
"entries": [
"text"
],
"evidenceData": {
"customFields": "[Circular Reference]",
"description": "[Circular Reference]",
"occurred": "[Circular Reference]",
"tags": "[Circular Reference]"
},
"executionCount": 1,
"externalFormUseAuth": true,
"fieldMapping": [
{
"fieldId": "text",
"output": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
}
}
],
"forEachIndex": 1,
"forEachInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{}
]
},
"form": {
"description": "text",
"expired": true,
"questions": "[Circular Reference]",
"sender": "text",
"title": "text",
"totalAnswers": 1
},
"formDisplay": {
"bodyBackgroundColor": "text",
"bodyFontColor": "text",
"headerBackgroundColor": "text",
"headerFontColor": "text",
"isExternalRtl": true,
"sender": "text",
"submitButtonBackgroundColor": "text",
"submitButtonFontColor": "text",
"submitText": "text"
},
"hasErrorEntries": true,
"id": "text",
"ignoreWorker": true,
"indent": 1,
"input": "text",
"isAutoSwitchedToQuietMode": true,
"isOverSize": true,
"loop": {
"brand": "text",
"builtinCondition": "[Circular Reference]",
"exitCondition": "text",
"forEach": true,
"isCommand": true,
"max": 1,
"scriptArguments": "[Circular Reference]",
"scriptId": "text",
"scriptName": "text",
"wait": 1
},
"message": {
"bcc": "[Circular Reference]",
"body": "[Circular Reference]",
"cc": "[Circular Reference]",
"defaultOption": "text",
"format": "text",
"methods": [
"text"
],
"replyOptions": [
"text"
],
"subject": "[Circular Reference]",
"timings": {
"completeAfterReplies": 1,
"completeAfterSLA": true,
"completeAfterV2": true,
"retriesCount": 1,
"retriesInterval": 1
},
"to": "[Circular Reference]"
},
"missingContentItem": "text",
"nextPollingTime": "2026-01-01T00:00:00.000Z",
"nextTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"note": true,
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"parentBlockCount": 1,
"parentPlaybookID": "text",
"patched": true,
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"pollingEntries": [
"text"
],
"pollingTimeoutTime": "2026-01-01T00:00:00.000Z",
"previousTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"quietMode": 1,
"reminder": 1,
"reputationCalc": 1,
"restrictedCompletion": true,
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"separateContext": true,
"skip": true,
"skipUnavailable": true,
"sla": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"slaReminder": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"startDate": "2026-01-01T00:00:00.000Z",
"startedExecutingHarmfulScript": true,
"state": "text",
"subPlaybook": {
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": "[Circular Reference]",
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": "[Circular Reference]",
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": "[Circular Reference]",
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": "[Circular Reference]",
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
},
"task": {
"brand": "text",
"cacheVersn": 1,
"clonedFrom": "text",
"comment": "text",
"conditions": [
"text"
],
"created": "2026-01-01T00:00:00.000Z",
"description": "text",
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"isCommand": true,
"isLocked": true,
"isTitleTask": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"playbookId": "text",
"playbookName": "text",
"primaryTerm": 1,
"scriptId": "text",
"sequenceNumber": 1,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"tags": [
"text"
],
"type": "text",
"version": 1
},
"taskCompleteData": [
{
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"calculatedDescription": "text",
"calculatedTaskName": "text",
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"entries": [
"text"
],
"hasErrorEntries": true,
"input": "text",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"startDate": "2026-01-01T00:00:00.000Z",
"state": "text",
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
],
"taskDebug": {
"breakpointCondition": "[Circular Reference]",
"inputOverrides": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"isMarkedWithBreakpoint": true,
"isMarkedWithSkip": true,
"outputOverrides": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"shouldOverrideDebugInfo": true,
"skipConditionOverrideTo": "text",
"taskOriginalId": "text"
},
"taskId": "text",
"taskSize": 1,
"timerTriggers": [
{
"action": "text",
"fieldName": "text"
}
],
"timesPolled": 1,
"type": "text",
"view": {},
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
},
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
}Set the task due date
Authorizations
AuthorizationstringRequired
Body
datestring · date-timeOptional
inTaskIDstringOptional
invIdstringOptional
versioninteger · int64Optional
Responses
200
InvestigationPlaybook
application/json
InvestigationPlaybook is a wrapper for a linked list of Playbook tasks
DirtybooleanOptional
ReplacedPlaybookbooleanOptional
Indicate whether this playbook has new history during this session
ShardIDinteger · int64Optional
UpdatedOperatorIDsbooleanOptional
allReadbooleanOptional
allReadWritebooleanOptional
autoExtractingbooleanOptional
cacheVersninteger · int64Optional
commentstringOptional
createdstring · date-timeOptional
dbotCreatedBystringOptional
Who has created this event - relevant only for manual incidents
hasRolebooleanOptional
Internal field to make queries on role faster
idstringOptional
incidentCreateDatestring · date-timeOptional
Incident create date
indexNamestringOptional
investigationIdstringOptional
isTIMbooleanOptional
modifiedstring · date-timeOptional
namestringOptional
numericIdinteger · int64Optional
playbookIdstringOptional
previousAllReadbooleanOptional
previousAllReadWritebooleanOptional
previousRolesstring[]Optional
Do not change this field manually
primaryTerminteger · int64Optional
quietbooleanOptional
recoveryAttemptsinteger · int64Optional
rolesstring[]Optional
The role assigned to this investigation
sequenceNumberinteger · int64Optional
serverIdstringOptional
Holds the ID of the responsible cluster app server
sizeInBytesinteger · int64Optional
sortValuesstring[]Optional
startDatestring · date-timeOptional
startTaskIdstringOptional
FirstTask is the root task of the playbook
statestringOptional
InvestigationPlaybookState indicates the state of the running playbook
syncHashstringOptional
versioninteger · int64Optional
viewobject · PlaybookViewOptional
PlaybookView represents the view in client of playbook graph
xsoarHasReadOnlyRolebooleanOptional
xsoarPreviousReadOnlyRolesstring[]Optional
xsoarReadOnlyRolesstring[]Optional
post/inv-playbook/task/due
POST /inv-playbook/task/due HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 80
{
"date": "2026-01-01T00:00:00.000Z",
"inTaskID": "text",
"invId": "text",
"version": 1
}200
InvestigationPlaybook
{
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
],
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": [
{
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"autoExtracting": true,
"comment": "text",
"inputs": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
],
"investigationId": "text",
"isTIM": true,
"name": "text",
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"quiet": true,
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
]
},
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"tasks": {
"ANY_ADDITIONAL_PROPERTY": {
"Reopen": true,
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"assignee": "text",
"assigneeSet": true,
"blockingTasks": [
"text"
],
"calculatedDescription": "text",
"calculatedTaskName": "text",
"comments": true,
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"conditions": [
"[Circular Reference]"
],
"continueOnError": true,
"continueOnErrorType": "text",
"defaultAssignee": "text",
"defaultAssigneeComplex": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"defaultReminder": 1,
"doNotSaveTaskHistory": true,
"dueDate": "2026-01-01T00:00:00.000Z",
"dueDateDuration": 1,
"dueDateDurationUnit": 1,
"dueDateSet": true,
"entries": [
"text"
],
"evidenceData": {
"customFields": "[Circular Reference]",
"description": "[Circular Reference]",
"occurred": "[Circular Reference]",
"tags": "[Circular Reference]"
},
"executionCount": 1,
"externalFormUseAuth": true,
"fieldMapping": [
"[Circular Reference]"
],
"forEachIndex": 1,
"forEachInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{}
]
},
"form": {
"description": "text",
"expired": true,
"questions": "[Circular Reference]",
"sender": "text",
"title": "text",
"totalAnswers": 1
},
"formDisplay": {
"bodyBackgroundColor": "text",
"bodyFontColor": "text",
"headerBackgroundColor": "text",
"headerFontColor": "text",
"isExternalRtl": true,
"sender": "text",
"submitButtonBackgroundColor": "text",
"submitButtonFontColor": "text",
"submitText": "text"
},
"hasErrorEntries": true,
"id": "text",
"ignoreWorker": true,
"indent": 1,
"input": "text",
"isAutoSwitchedToQuietMode": true,
"isOverSize": true,
"loop": {
"brand": "text",
"builtinCondition": "[Circular Reference]",
"exitCondition": "text",
"forEach": true,
"isCommand": true,
"max": 1,
"scriptArguments": "[Circular Reference]",
"scriptId": "text",
"scriptName": "text",
"wait": 1
},
"message": {
"bcc": "[Circular Reference]",
"body": "[Circular Reference]",
"cc": "[Circular Reference]",
"defaultOption": "text",
"format": "text",
"methods": [
"text"
],
"replyOptions": [
"text"
],
"subject": "[Circular Reference]",
"timings": {
"completeAfterReplies": 1,
"completeAfterSLA": true,
"completeAfterV2": true,
"retriesCount": 1,
"retriesInterval": 1
},
"to": "[Circular Reference]"
},
"missingContentItem": "text",
"nextPollingTime": "2026-01-01T00:00:00.000Z",
"nextTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"note": true,
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"parentBlockCount": 1,
"parentPlaybookID": "text",
"patched": true,
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"pollingEntries": [
"text"
],
"pollingTimeoutTime": "2026-01-01T00:00:00.000Z",
"previousTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"quietMode": 1,
"reminder": 1,
"reputationCalc": 1,
"restrictedCompletion": true,
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"separateContext": true,
"skip": true,
"skipUnavailable": true,
"sla": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"slaReminder": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"startDate": "2026-01-01T00:00:00.000Z",
"startedExecutingHarmfulScript": true,
"state": "text",
"subPlaybook": {
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": "[Circular Reference]",
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": "[Circular Reference]",
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": "[Circular Reference]",
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": "[Circular Reference]",
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
},
"task": {
"brand": "text",
"cacheVersn": 1,
"clonedFrom": "text",
"comment": "text",
"conditions": [
"text"
],
"created": "2026-01-01T00:00:00.000Z",
"description": "text",
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"isCommand": true,
"isLocked": true,
"isTitleTask": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"playbookId": "text",
"playbookName": "text",
"primaryTerm": 1,
"scriptId": "text",
"sequenceNumber": 1,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"tags": [
"text"
],
"type": "text",
"version": 1
},
"taskCompleteData": [
{
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"calculatedDescription": "text",
"calculatedTaskName": "text",
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"entries": [
"text"
],
"hasErrorEntries": true,
"input": "text",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"startDate": "2026-01-01T00:00:00.000Z",
"state": "text",
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
],
"taskDebug": {
"breakpointCondition": "[Circular Reference]",
"inputOverrides": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"isMarkedWithBreakpoint": true,
"isMarkedWithSkip": true,
"outputOverrides": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"shouldOverrideDebugInfo": true,
"skipConditionOverrideTo": "text",
"taskOriginalId": "text"
},
"taskId": "text",
"taskSize": 1,
"timerTriggers": [
{
"action": "text",
"fieldName": "text"
}
],
"timesPolled": 1,
"type": "text",
"view": {},
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
},
"view": {}
}
],
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
]
},
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": {
"ANY_ADDITIONAL_PROPERTY": {
"Reopen": true,
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"assignee": "text",
"assigneeSet": true,
"blockingTasks": [
"text"
],
"calculatedDescription": "text",
"calculatedTaskName": "text",
"comments": true,
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"conditions": [
{
"condition": [
"[Circular Reference]"
],
"label": "text"
}
],
"continueOnError": true,
"continueOnErrorType": "text",
"defaultAssignee": "text",
"defaultAssigneeComplex": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"defaultReminder": 1,
"doNotSaveTaskHistory": true,
"dueDate": "2026-01-01T00:00:00.000Z",
"dueDateDuration": 1,
"dueDateDurationUnit": 1,
"dueDateSet": true,
"entries": [
"text"
],
"evidenceData": {
"customFields": "[Circular Reference]",
"description": "[Circular Reference]",
"occurred": "[Circular Reference]",
"tags": "[Circular Reference]"
},
"executionCount": 1,
"externalFormUseAuth": true,
"fieldMapping": [
{
"fieldId": "text",
"output": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
}
}
],
"forEachIndex": 1,
"forEachInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{}
]
},
"form": {
"description": "text",
"expired": true,
"questions": "[Circular Reference]",
"sender": "text",
"title": "text",
"totalAnswers": 1
},
"formDisplay": {
"bodyBackgroundColor": "text",
"bodyFontColor": "text",
"headerBackgroundColor": "text",
"headerFontColor": "text",
"isExternalRtl": true,
"sender": "text",
"submitButtonBackgroundColor": "text",
"submitButtonFontColor": "text",
"submitText": "text"
},
"hasErrorEntries": true,
"id": "text",
"ignoreWorker": true,
"indent": 1,
"input": "text",
"isAutoSwitchedToQuietMode": true,
"isOverSize": true,
"loop": {
"brand": "text",
"builtinCondition": "[Circular Reference]",
"exitCondition": "text",
"forEach": true,
"isCommand": true,
"max": 1,
"scriptArguments": "[Circular Reference]",
"scriptId": "text",
"scriptName": "text",
"wait": 1
},
"message": {
"bcc": "[Circular Reference]",
"body": "[Circular Reference]",
"cc": "[Circular Reference]",
"defaultOption": "text",
"format": "text",
"methods": [
"text"
],
"replyOptions": [
"text"
],
"subject": "[Circular Reference]",
"timings": {
"completeAfterReplies": 1,
"completeAfterSLA": true,
"completeAfterV2": true,
"retriesCount": 1,
"retriesInterval": 1
},
"to": "[Circular Reference]"
},
"missingContentItem": "text",
"nextPollingTime": "2026-01-01T00:00:00.000Z",
"nextTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"note": true,
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"parentBlockCount": 1,
"parentPlaybookID": "text",
"patched": true,
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"pollingEntries": [
"text"
],
"pollingTimeoutTime": "2026-01-01T00:00:00.000Z",
"previousTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"quietMode": 1,
"reminder": 1,
"reputationCalc": 1,
"restrictedCompletion": true,
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"separateContext": true,
"skip": true,
"skipUnavailable": true,
"sla": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"slaReminder": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"startDate": "2026-01-01T00:00:00.000Z",
"startedExecutingHarmfulScript": true,
"state": "text",
"subPlaybook": {
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": "[Circular Reference]",
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": "[Circular Reference]",
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": "[Circular Reference]",
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": "[Circular Reference]",
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
},
"task": {
"brand": "text",
"cacheVersn": 1,
"clonedFrom": "text",
"comment": "text",
"conditions": [
"text"
],
"created": "2026-01-01T00:00:00.000Z",
"description": "text",
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"isCommand": true,
"isLocked": true,
"isTitleTask": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"playbookId": "text",
"playbookName": "text",
"primaryTerm": 1,
"scriptId": "text",
"sequenceNumber": 1,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"tags": [
"text"
],
"type": "text",
"version": 1
},
"taskCompleteData": [
{
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"calculatedDescription": "text",
"calculatedTaskName": "text",
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"entries": [
"text"
],
"hasErrorEntries": true,
"input": "text",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"startDate": "2026-01-01T00:00:00.000Z",
"state": "text",
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
],
"taskDebug": {
"breakpointCondition": "[Circular Reference]",
"inputOverrides": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"isMarkedWithBreakpoint": true,
"isMarkedWithSkip": true,
"outputOverrides": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"shouldOverrideDebugInfo": true,
"skipConditionOverrideTo": "text",
"taskOriginalId": "text"
},
"taskId": "text",
"taskSize": 1,
"timerTriggers": [
{
"action": "text",
"fieldName": "text"
}
],
"timesPolled": 1,
"type": "text",
"view": {},
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
},
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
}Edit an ad-hoc task in a running playbook
Authorizations
AuthorizationstringRequired
Path parameters
investigationIdstringRequired
investigation ID
Body
addAfterbooleanOptional
addToSeparateBranchbooleanOptional
automationScriptstringOptional
descriptionstringOptional
namestringOptional
neighborInvPBTaskIdstringOptional
playbookIdstringOptional
separateContextbooleanOptional
tagsstring[]Optional
typestringOptional
TaskType is the Task in the playbook context as a node
Responses
200
InvestigationPlaybook
application/json
InvestigationPlaybook is a wrapper for a linked list of Playbook tasks
DirtybooleanOptional
ReplacedPlaybookbooleanOptional
Indicate whether this playbook has new history during this session
ShardIDinteger · int64Optional
UpdatedOperatorIDsbooleanOptional
allReadbooleanOptional
allReadWritebooleanOptional
autoExtractingbooleanOptional
cacheVersninteger · int64Optional
commentstringOptional
createdstring · date-timeOptional
dbotCreatedBystringOptional
Who has created this event - relevant only for manual incidents
hasRolebooleanOptional
Internal field to make queries on role faster
idstringOptional
incidentCreateDatestring · date-timeOptional
Incident create date
indexNamestringOptional
investigationIdstringOptional
isTIMbooleanOptional
modifiedstring · date-timeOptional
namestringOptional
numericIdinteger · int64Optional
playbookIdstringOptional
previousAllReadbooleanOptional
previousAllReadWritebooleanOptional
previousRolesstring[]Optional
Do not change this field manually
primaryTerminteger · int64Optional
quietbooleanOptional
recoveryAttemptsinteger · int64Optional
rolesstring[]Optional
The role assigned to this investigation
sequenceNumberinteger · int64Optional
serverIdstringOptional
Holds the ID of the responsible cluster app server
sizeInBytesinteger · int64Optional
sortValuesstring[]Optional
startDatestring · date-timeOptional
startTaskIdstringOptional
FirstTask is the root task of the playbook
statestringOptional
InvestigationPlaybookState indicates the state of the running playbook
syncHashstringOptional
versioninteger · int64Optional
viewobject · PlaybookViewOptional
PlaybookView represents the view in client of playbook graph
xsoarHasReadOnlyRolebooleanOptional
xsoarPreviousReadOnlyRolesstring[]Optional
xsoarReadOnlyRolesstring[]Optional
post/inv-playbook/task/edit/{investigationId}
POST /inv-playbook/task/edit/{investigationId} HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1015
{
"addAfter": true,
"addToSeparateBranch": true,
"automationScript": "text",
"description": "text",
"loop": {
"brand": "text",
"builtinCondition": [
[
{
"ignoreCase": true,
"left": {
"isContext": true,
"value": "[Circular Reference]"
},
"operator": "text",
"right": {
"isContext": true,
"value": "[Circular Reference]"
},
"type": "text"
}
]
],
"exitCondition": "text",
"forEach": true,
"isCommand": true,
"max": 1,
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
},
"scriptId": "text",
"scriptName": "text",
"wait": 1
},
"name": "text",
"neighborInvPBTaskId": "text",
"playbookId": "text",
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
},
"separateContext": true,
"tags": [
"text"
],
"type": "text"
}200
InvestigationPlaybook
{
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
],
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": [
{
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"autoExtracting": true,
"comment": "text",
"inputs": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
],
"investigationId": "text",
"isTIM": true,
"name": "text",
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"quiet": true,
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
]
},
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"tasks": {
"ANY_ADDITIONAL_PROPERTY": {
"Reopen": true,
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"assignee": "text",
"assigneeSet": true,
"blockingTasks": [
"text"
],
"calculatedDescription": "text",
"calculatedTaskName": "text",
"comments": true,
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"conditions": [
"[Circular Reference]"
],
"continueOnError": true,
"continueOnErrorType": "text",
"defaultAssignee": "text",
"defaultAssigneeComplex": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"defaultReminder": 1,
"doNotSaveTaskHistory": true,
"dueDate": "2026-01-01T00:00:00.000Z",
"dueDateDuration": 1,
"dueDateDurationUnit": 1,
"dueDateSet": true,
"entries": [
"text"
],
"evidenceData": {
"customFields": "[Circular Reference]",
"description": "[Circular Reference]",
"occurred": "[Circular Reference]",
"tags": "[Circular Reference]"
},
"executionCount": 1,
"externalFormUseAuth": true,
"fieldMapping": [
"[Circular Reference]"
],
"forEachIndex": 1,
"forEachInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{}
]
},
"form": {
"description": "text",
"expired": true,
"questions": "[Circular Reference]",
"sender": "text",
"title": "text",
"totalAnswers": 1
},
"formDisplay": {
"bodyBackgroundColor": "text",
"bodyFontColor": "text",
"headerBackgroundColor": "text",
"headerFontColor": "text",
"isExternalRtl": true,
"sender": "text",
"submitButtonBackgroundColor": "text",
"submitButtonFontColor": "text",
"submitText": "text"
},
"hasErrorEntries": true,
"id": "text",
"ignoreWorker": true,
"indent": 1,
"input": "text",
"isAutoSwitchedToQuietMode": true,
"isOverSize": true,
"loop": {
"brand": "text",
"builtinCondition": "[Circular Reference]",
"exitCondition": "text",
"forEach": true,
"isCommand": true,
"max": 1,
"scriptArguments": "[Circular Reference]",
"scriptId": "text",
"scriptName": "text",
"wait": 1
},
"message": {
"bcc": "[Circular Reference]",
"body": "[Circular Reference]",
"cc": "[Circular Reference]",
"defaultOption": "text",
"format": "text",
"methods": [
"text"
],
"replyOptions": [
"text"
],
"subject": "[Circular Reference]",
"timings": {
"completeAfterReplies": 1,
"completeAfterSLA": true,
"completeAfterV2": true,
"retriesCount": 1,
"retriesInterval": 1
},
"to": "[Circular Reference]"
},
"missingContentItem": "text",
"nextPollingTime": "2026-01-01T00:00:00.000Z",
"nextTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"note": true,
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"parentBlockCount": 1,
"parentPlaybookID": "text",
"patched": true,
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"pollingEntries": [
"text"
],
"pollingTimeoutTime": "2026-01-01T00:00:00.000Z",
"previousTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"quietMode": 1,
"reminder": 1,
"reputationCalc": 1,
"restrictedCompletion": true,
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"separateContext": true,
"skip": true,
"skipUnavailable": true,
"sla": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"slaReminder": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"startDate": "2026-01-01T00:00:00.000Z",
"startedExecutingHarmfulScript": true,
"state": "text",
"subPlaybook": {
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": "[Circular Reference]",
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": "[Circular Reference]",
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": "[Circular Reference]",
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": "[Circular Reference]",
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
},
"task": {
"brand": "text",
"cacheVersn": 1,
"clonedFrom": "text",
"comment": "text",
"conditions": [
"text"
],
"created": "2026-01-01T00:00:00.000Z",
"description": "text",
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"isCommand": true,
"isLocked": true,
"isTitleTask": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"playbookId": "text",
"playbookName": "text",
"primaryTerm": 1,
"scriptId": "text",
"sequenceNumber": 1,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"tags": [
"text"
],
"type": "text",
"version": 1
},
"taskCompleteData": [
{
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"calculatedDescription": "text",
"calculatedTaskName": "text",
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"entries": [
"text"
],
"hasErrorEntries": true,
"input": "text",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"startDate": "2026-01-01T00:00:00.000Z",
"state": "text",
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
],
"taskDebug": {
"breakpointCondition": "[Circular Reference]",
"inputOverrides": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"isMarkedWithBreakpoint": true,
"isMarkedWithSkip": true,
"outputOverrides": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"shouldOverrideDebugInfo": true,
"skipConditionOverrideTo": "text",
"taskOriginalId": "text"
},
"taskId": "text",
"taskSize": 1,
"timerTriggers": [
{
"action": "text",
"fieldName": "text"
}
],
"timesPolled": 1,
"type": "text",
"view": {},
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
},
"view": {}
}
],
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
]
},
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": {
"ANY_ADDITIONAL_PROPERTY": {
"Reopen": true,
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"assignee": "text",
"assigneeSet": true,
"blockingTasks": [
"text"
],
"calculatedDescription": "text",
"calculatedTaskName": "text",
"comments": true,
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"conditions": [
{
"condition": [
"[Circular Reference]"
],
"label": "text"
}
],
"continueOnError": true,
"continueOnErrorType": "text",
"defaultAssignee": "text",
"defaultAssigneeComplex": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"defaultReminder": 1,
"doNotSaveTaskHistory": true,
"dueDate": "2026-01-01T00:00:00.000Z",
"dueDateDuration": 1,
"dueDateDurationUnit": 1,
"dueDateSet": true,
"entries": [
"text"
],
"evidenceData": {
"customFields": "[Circular Reference]",
"description": "[Circular Reference]",
"occurred": "[Circular Reference]",
"tags": "[Circular Reference]"
},
"executionCount": 1,
"externalFormUseAuth": true,
"fieldMapping": [
{
"fieldId": "text",
"output": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
}
}
],
"forEachIndex": 1,
"forEachInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{}
]
},
"form": {
"description": "text",
"expired": true,
"questions": "[Circular Reference]",
"sender": "text",
"title": "text",
"totalAnswers": 1
},
"formDisplay": {
"bodyBackgroundColor": "text",
"bodyFontColor": "text",
"headerBackgroundColor": "text",
"headerFontColor": "text",
"isExternalRtl": true,
"sender": "text",
"submitButtonBackgroundColor": "text",
"submitButtonFontColor": "text",
"submitText": "text"
},
"hasErrorEntries": true,
"id": "text",
"ignoreWorker": true,
"indent": 1,
"input": "text",
"isAutoSwitchedToQuietMode": true,
"isOverSize": true,
"loop": {
"brand": "text",
"builtinCondition": "[Circular Reference]",
"exitCondition": "text",
"forEach": true,
"isCommand": true,
"max": 1,
"scriptArguments": "[Circular Reference]",
"scriptId": "text",
"scriptName": "text",
"wait": 1
},
"message": {
"bcc": "[Circular Reference]",
"body": "[Circular Reference]",
"cc": "[Circular Reference]",
"defaultOption": "text",
"format": "text",
"methods": [
"text"
],
"replyOptions": [
"text"
],
"subject": "[Circular Reference]",
"timings": {
"completeAfterReplies": 1,
"completeAfterSLA": true,
"completeAfterV2": true,
"retriesCount": 1,
"retriesInterval": 1
},
"to": "[Circular Reference]"
},
"missingContentItem": "text",
"nextPollingTime": "2026-01-01T00:00:00.000Z",
"nextTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"note": true,
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"parentBlockCount": 1,
"parentPlaybookID": "text",
"patched": true,
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"pollingEntries": [
"text"
],
"pollingTimeoutTime": "2026-01-01T00:00:00.000Z",
"previousTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"quietMode": 1,
"reminder": 1,
"reputationCalc": 1,
"restrictedCompletion": true,
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"separateContext": true,
"skip": true,
"skipUnavailable": true,
"sla": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"slaReminder": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"startDate": "2026-01-01T00:00:00.000Z",
"startedExecutingHarmfulScript": true,
"state": "text",
"subPlaybook": {
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": "[Circular Reference]",
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": "[Circular Reference]",
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": "[Circular Reference]",
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": "[Circular Reference]",
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
},
"task": {
"brand": "text",
"cacheVersn": 1,
"clonedFrom": "text",
"comment": "text",
"conditions": [
"text"
],
"created": "2026-01-01T00:00:00.000Z",
"description": "text",
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"isCommand": true,
"isLocked": true,
"isTitleTask": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"playbookId": "text",
"playbookName": "text",
"primaryTerm": 1,
"scriptId": "text",
"sequenceNumber": 1,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"tags": [
"text"
],
"type": "text",
"version": 1
},
"taskCompleteData": [
{
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"calculatedDescription": "text",
"calculatedTaskName": "text",
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"entries": [
"text"
],
"hasErrorEntries": true,
"input": "text",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"startDate": "2026-01-01T00:00:00.000Z",
"state": "text",
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
],
"taskDebug": {
"breakpointCondition": "[Circular Reference]",
"inputOverrides": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"isMarkedWithBreakpoint": true,
"isMarkedWithSkip": true,
"outputOverrides": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"shouldOverrideDebugInfo": true,
"skipConditionOverrideTo": "text",
"taskOriginalId": "text"
},
"taskId": "text",
"taskSize": 1,
"timerTriggers": [
{
"action": "text",
"fieldName": "text"
}
],
"timesPolled": 1,
"type": "text",
"view": {},
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
},
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
}Add comment to a task
Authorizations
AuthorizationstringRequired
Body
commentstringOptional
inTaskIDstringOptional
inputstringOptional
invIdstringOptional
versioninteger · int64Optional
Responses
200
InvestigationPlaybook
application/json
InvestigationPlaybook is a wrapper for a linked list of Playbook tasks
DirtybooleanOptional
ReplacedPlaybookbooleanOptional
Indicate whether this playbook has new history during this session
ShardIDinteger · int64Optional
UpdatedOperatorIDsbooleanOptional
allReadbooleanOptional
allReadWritebooleanOptional
autoExtractingbooleanOptional
cacheVersninteger · int64Optional
commentstringOptional
createdstring · date-timeOptional
dbotCreatedBystringOptional
Who has created this event - relevant only for manual incidents
hasRolebooleanOptional
Internal field to make queries on role faster
idstringOptional
incidentCreateDatestring · date-timeOptional
Incident create date
indexNamestringOptional
investigationIdstringOptional
isTIMbooleanOptional
modifiedstring · date-timeOptional
namestringOptional
numericIdinteger · int64Optional
playbookIdstringOptional
previousAllReadbooleanOptional
previousAllReadWritebooleanOptional
previousRolesstring[]Optional
Do not change this field manually
primaryTerminteger · int64Optional
quietbooleanOptional
recoveryAttemptsinteger · int64Optional
rolesstring[]Optional
The role assigned to this investigation
sequenceNumberinteger · int64Optional
serverIdstringOptional
Holds the ID of the responsible cluster app server
sizeInBytesinteger · int64Optional
sortValuesstring[]Optional
startDatestring · date-timeOptional
startTaskIdstringOptional
FirstTask is the root task of the playbook
statestringOptional
InvestigationPlaybookState indicates the state of the running playbook
syncHashstringOptional
versioninteger · int64Optional
viewobject · PlaybookViewOptional
PlaybookView represents the view in client of playbook graph
xsoarHasReadOnlyRolebooleanOptional
xsoarPreviousReadOnlyRolesstring[]Optional
xsoarReadOnlyRolesstring[]Optional
post/inv-playbook/task/note/add
POST /inv-playbook/task/note/add HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1250
{
"args": {
"ANY_ADDITIONAL_PROPERTY": {
"complex": {
"accessor": "text",
"filters": [
[
"[Circular Reference]"
]
],
"root": "text",
"transformers": [
{
"args": "[Circular Reference]",
"operator": "text"
}
]
},
"keyValue": [
{
"key": "text",
"value": {
"complex": {
"accessor": "text",
"filters": [
[
"[Circular Reference]"
]
],
"root": "text",
"transformers": [
{
"args": "[Circular Reference]",
"operator": "text"
}
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
}
}
],
"simple": "text"
}
},
"comment": "text",
"conditions": [
{
"condition": [
[
{
"ignoreCase": true,
"left": "[Circular Reference]",
"operator": "text",
"right": "[Circular Reference]",
"type": "text"
}
]
],
"label": "text"
}
],
"inTaskID": "text",
"input": "text",
"invId": "text",
"loopArgs": {
"ANY_ADDITIONAL_PROPERTY": {
"complex": {
"accessor": "text",
"filters": [
[
"[Circular Reference]"
]
],
"root": "text",
"transformers": [
{
"args": "[Circular Reference]",
"operator": "text"
}
]
},
"keyValue": [
{
"key": "text",
"value": {
"complex": {
"accessor": "text",
"filters": [
[
"[Circular Reference]"
]
],
"root": "text",
"transformers": [
{
"args": "[Circular Reference]",
"operator": "text"
}
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
}
}
],
"simple": "text"
}
},
"loopCondition": [
[
{
"ignoreCase": true,
"left": "[Circular Reference]",
"operator": "text",
"right": "[Circular Reference]",
"type": "text"
}
]
],
"version": 1
}200
InvestigationPlaybook
{
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
],
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": [
{
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"autoExtracting": true,
"comment": "text",
"inputs": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
],
"investigationId": "text",
"isTIM": true,
"name": "text",
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"quiet": true,
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
]
},
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"tasks": {
"ANY_ADDITIONAL_PROPERTY": {
"Reopen": true,
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"assignee": "text",
"assigneeSet": true,
"blockingTasks": [
"text"
],
"calculatedDescription": "text",
"calculatedTaskName": "text",
"comments": true,
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"conditions": [
"[Circular Reference]"
],
"continueOnError": true,
"continueOnErrorType": "text",
"defaultAssignee": "text",
"defaultAssigneeComplex": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"defaultReminder": 1,
"doNotSaveTaskHistory": true,
"dueDate": "2026-01-01T00:00:00.000Z",
"dueDateDuration": 1,
"dueDateDurationUnit": 1,
"dueDateSet": true,
"entries": [
"text"
],
"evidenceData": {
"customFields": "[Circular Reference]",
"description": "[Circular Reference]",
"occurred": "[Circular Reference]",
"tags": "[Circular Reference]"
},
"executionCount": 1,
"externalFormUseAuth": true,
"fieldMapping": [
"[Circular Reference]"
],
"forEachIndex": 1,
"forEachInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{}
]
},
"form": {
"description": "text",
"expired": true,
"questions": "[Circular Reference]",
"sender": "text",
"title": "text",
"totalAnswers": 1
},
"formDisplay": {
"bodyBackgroundColor": "text",
"bodyFontColor": "text",
"headerBackgroundColor": "text",
"headerFontColor": "text",
"isExternalRtl": true,
"sender": "text",
"submitButtonBackgroundColor": "text",
"submitButtonFontColor": "text",
"submitText": "text"
},
"hasErrorEntries": true,
"id": "text",
"ignoreWorker": true,
"indent": 1,
"input": "text",
"isAutoSwitchedToQuietMode": true,
"isOverSize": true,
"loop": {
"brand": "text",
"builtinCondition": "[Circular Reference]",
"exitCondition": "text",
"forEach": true,
"isCommand": true,
"max": 1,
"scriptArguments": "[Circular Reference]",
"scriptId": "text",
"scriptName": "text",
"wait": 1
},
"message": {
"bcc": "[Circular Reference]",
"body": "[Circular Reference]",
"cc": "[Circular Reference]",
"defaultOption": "text",
"format": "text",
"methods": [
"text"
],
"replyOptions": [
"text"
],
"subject": "[Circular Reference]",
"timings": {
"completeAfterReplies": 1,
"completeAfterSLA": true,
"completeAfterV2": true,
"retriesCount": 1,
"retriesInterval": 1
},
"to": "[Circular Reference]"
},
"missingContentItem": "text",
"nextPollingTime": "2026-01-01T00:00:00.000Z",
"nextTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"note": true,
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"parentBlockCount": 1,
"parentPlaybookID": "text",
"patched": true,
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"pollingEntries": [
"text"
],
"pollingTimeoutTime": "2026-01-01T00:00:00.000Z",
"previousTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"quietMode": 1,
"reminder": 1,
"reputationCalc": 1,
"restrictedCompletion": true,
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"separateContext": true,
"skip": true,
"skipUnavailable": true,
"sla": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"slaReminder": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"startDate": "2026-01-01T00:00:00.000Z",
"startedExecutingHarmfulScript": true,
"state": "text",
"subPlaybook": {
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": "[Circular Reference]",
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": "[Circular Reference]",
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": "[Circular Reference]",
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": "[Circular Reference]",
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
},
"task": {
"brand": "text",
"cacheVersn": 1,
"clonedFrom": "text",
"comment": "text",
"conditions": [
"text"
],
"created": "2026-01-01T00:00:00.000Z",
"description": "text",
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"isCommand": true,
"isLocked": true,
"isTitleTask": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"playbookId": "text",
"playbookName": "text",
"primaryTerm": 1,
"scriptId": "text",
"sequenceNumber": 1,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"tags": [
"text"
],
"type": "text",
"version": 1
},
"taskCompleteData": [
{
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"calculatedDescription": "text",
"calculatedTaskName": "text",
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"entries": [
"text"
],
"hasErrorEntries": true,
"input": "text",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"startDate": "2026-01-01T00:00:00.000Z",
"state": "text",
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
],
"taskDebug": {
"breakpointCondition": "[Circular Reference]",
"inputOverrides": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"isMarkedWithBreakpoint": true,
"isMarkedWithSkip": true,
"outputOverrides": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"shouldOverrideDebugInfo": true,
"skipConditionOverrideTo": "text",
"taskOriginalId": "text"
},
"taskId": "text",
"taskSize": 1,
"timerTriggers": [
{
"action": "text",
"fieldName": "text"
}
],
"timesPolled": 1,
"type": "text",
"view": {},
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
},
"view": {}
}
],
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
]
},
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": {
"ANY_ADDITIONAL_PROPERTY": {
"Reopen": true,
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"assignee": "text",
"assigneeSet": true,
"blockingTasks": [
"text"
],
"calculatedDescription": "text",
"calculatedTaskName": "text",
"comments": true,
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"conditions": [
{
"condition": [
"[Circular Reference]"
],
"label": "text"
}
],
"continueOnError": true,
"continueOnErrorType": "text",
"defaultAssignee": "text",
"defaultAssigneeComplex": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"defaultReminder": 1,
"doNotSaveTaskHistory": true,
"dueDate": "2026-01-01T00:00:00.000Z",
"dueDateDuration": 1,
"dueDateDurationUnit": 1,
"dueDateSet": true,
"entries": [
"text"
],
"evidenceData": {
"customFields": "[Circular Reference]",
"description": "[Circular Reference]",
"occurred": "[Circular Reference]",
"tags": "[Circular Reference]"
},
"executionCount": 1,
"externalFormUseAuth": true,
"fieldMapping": [
{
"fieldId": "text",
"output": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
}
}
],
"forEachIndex": 1,
"forEachInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{}
]
},
"form": {
"description": "text",
"expired": true,
"questions": "[Circular Reference]",
"sender": "text",
"title": "text",
"totalAnswers": 1
},
"formDisplay": {
"bodyBackgroundColor": "text",
"bodyFontColor": "text",
"headerBackgroundColor": "text",
"headerFontColor": "text",
"isExternalRtl": true,
"sender": "text",
"submitButtonBackgroundColor": "text",
"submitButtonFontColor": "text",
"submitText": "text"
},
"hasErrorEntries": true,
"id": "text",
"ignoreWorker": true,
"indent": 1,
"input": "text",
"isAutoSwitchedToQuietMode": true,
"isOverSize": true,
"loop": {
"brand": "text",
"builtinCondition": "[Circular Reference]",
"exitCondition": "text",
"forEach": true,
"isCommand": true,
"max": 1,
"scriptArguments": "[Circular Reference]",
"scriptId": "text",
"scriptName": "text",
"wait": 1
},
"message": {
"bcc": "[Circular Reference]",
"body": "[Circular Reference]",
"cc": "[Circular Reference]",
"defaultOption": "text",
"format": "text",
"methods": [
"text"
],
"replyOptions": [
"text"
],
"subject": "[Circular Reference]",
"timings": {
"completeAfterReplies": 1,
"completeAfterSLA": true,
"completeAfterV2": true,
"retriesCount": 1,
"retriesInterval": 1
},
"to": "[Circular Reference]"
},
"missingContentItem": "text",
"nextPollingTime": "2026-01-01T00:00:00.000Z",
"nextTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"note": true,
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"parentBlockCount": 1,
"parentPlaybookID": "text",
"patched": true,
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"pollingEntries": [
"text"
],
"pollingTimeoutTime": "2026-01-01T00:00:00.000Z",
"previousTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"quietMode": 1,
"reminder": 1,
"reputationCalc": 1,
"restrictedCompletion": true,
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"separateContext": true,
"skip": true,
"skipUnavailable": true,
"sla": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"slaReminder": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"startDate": "2026-01-01T00:00:00.000Z",
"startedExecutingHarmfulScript": true,
"state": "text",
"subPlaybook": {
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": "[Circular Reference]",
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": "[Circular Reference]",
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": "[Circular Reference]",
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": "[Circular Reference]",
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
},
"task": {
"brand": "text",
"cacheVersn": 1,
"clonedFrom": "text",
"comment": "text",
"conditions": [
"text"
],
"created": "2026-01-01T00:00:00.000Z",
"description": "text",
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"isCommand": true,
"isLocked": true,
"isTitleTask": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"playbookId": "text",
"playbookName": "text",
"primaryTerm": 1,
"scriptId": "text",
"sequenceNumber": 1,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"tags": [
"text"
],
"type": "text",
"version": 1
},
"taskCompleteData": [
{
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"calculatedDescription": "text",
"calculatedTaskName": "text",
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"entries": [
"text"
],
"hasErrorEntries": true,
"input": "text",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"startDate": "2026-01-01T00:00:00.000Z",
"state": "text",
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
],
"taskDebug": {
"breakpointCondition": "[Circular Reference]",
"inputOverrides": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"isMarkedWithBreakpoint": true,
"isMarkedWithSkip": true,
"outputOverrides": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"shouldOverrideDebugInfo": true,
"skipConditionOverrideTo": "text",
"taskOriginalId": "text"
},
"taskId": "text",
"taskSize": 1,
"timerTriggers": [
{
"action": "text",
"fieldName": "text"
}
],
"timesPolled": 1,
"type": "text",
"view": {},
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
},
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
}Reopen a closed task and change the status to uncomplete
Authorizations
AuthorizationstringRequired
Body
commentstringOptional
inTaskIDstringOptional
inputstringOptional
invIdstringOptional
versioninteger · int64Optional
Responses
200
InvestigationPlaybook
application/json
InvestigationPlaybook is a wrapper for a linked list of Playbook tasks
DirtybooleanOptional
ReplacedPlaybookbooleanOptional
Indicate whether this playbook has new history during this session
ShardIDinteger · int64Optional
UpdatedOperatorIDsbooleanOptional
allReadbooleanOptional
allReadWritebooleanOptional
autoExtractingbooleanOptional
cacheVersninteger · int64Optional
commentstringOptional
createdstring · date-timeOptional
dbotCreatedBystringOptional
Who has created this event - relevant only for manual incidents
hasRolebooleanOptional
Internal field to make queries on role faster
idstringOptional
incidentCreateDatestring · date-timeOptional
Incident create date
indexNamestringOptional
investigationIdstringOptional
isTIMbooleanOptional
modifiedstring · date-timeOptional
namestringOptional
numericIdinteger · int64Optional
playbookIdstringOptional
previousAllReadbooleanOptional
previousAllReadWritebooleanOptional
previousRolesstring[]Optional
Do not change this field manually
primaryTerminteger · int64Optional
quietbooleanOptional
recoveryAttemptsinteger · int64Optional
rolesstring[]Optional
The role assigned to this investigation
sequenceNumberinteger · int64Optional
serverIdstringOptional
Holds the ID of the responsible cluster app server
sizeInBytesinteger · int64Optional
sortValuesstring[]Optional
startDatestring · date-timeOptional
startTaskIdstringOptional
FirstTask is the root task of the playbook
statestringOptional
InvestigationPlaybookState indicates the state of the running playbook
syncHashstringOptional
versioninteger · int64Optional
viewobject · PlaybookViewOptional
PlaybookView represents the view in client of playbook graph
xsoarHasReadOnlyRolebooleanOptional
xsoarPreviousReadOnlyRolesstring[]Optional
xsoarReadOnlyRolesstring[]Optional
post/inv-playbook/task/uncomplete
POST /inv-playbook/task/uncomplete HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1250
{
"args": {
"ANY_ADDITIONAL_PROPERTY": {
"complex": {
"accessor": "text",
"filters": [
[
"[Circular Reference]"
]
],
"root": "text",
"transformers": [
{
"args": "[Circular Reference]",
"operator": "text"
}
]
},
"keyValue": [
{
"key": "text",
"value": {
"complex": {
"accessor": "text",
"filters": [
[
"[Circular Reference]"
]
],
"root": "text",
"transformers": [
{
"args": "[Circular Reference]",
"operator": "text"
}
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
}
}
],
"simple": "text"
}
},
"comment": "text",
"conditions": [
{
"condition": [
[
{
"ignoreCase": true,
"left": "[Circular Reference]",
"operator": "text",
"right": "[Circular Reference]",
"type": "text"
}
]
],
"label": "text"
}
],
"inTaskID": "text",
"input": "text",
"invId": "text",
"loopArgs": {
"ANY_ADDITIONAL_PROPERTY": {
"complex": {
"accessor": "text",
"filters": [
[
"[Circular Reference]"
]
],
"root": "text",
"transformers": [
{
"args": "[Circular Reference]",
"operator": "text"
}
]
},
"keyValue": [
{
"key": "text",
"value": {
"complex": {
"accessor": "text",
"filters": [
[
"[Circular Reference]"
]
],
"root": "text",
"transformers": [
{
"args": "[Circular Reference]",
"operator": "text"
}
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
}
}
],
"simple": "text"
}
},
"loopCondition": [
[
{
"ignoreCase": true,
"left": "[Circular Reference]",
"operator": "text",
"right": "[Circular Reference]",
"type": "text"
}
]
],
"version": 1
}200
InvestigationPlaybook
{
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
],
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": [
{
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"autoExtracting": true,
"comment": "text",
"inputs": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
],
"investigationId": "text",
"isTIM": true,
"name": "text",
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"quiet": true,
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
]
},
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"tasks": {
"ANY_ADDITIONAL_PROPERTY": {
"Reopen": true,
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"assignee": "text",
"assigneeSet": true,
"blockingTasks": [
"text"
],
"calculatedDescription": "text",
"calculatedTaskName": "text",
"comments": true,
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"conditions": [
"[Circular Reference]"
],
"continueOnError": true,
"continueOnErrorType": "text",
"defaultAssignee": "text",
"defaultAssigneeComplex": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"defaultReminder": 1,
"doNotSaveTaskHistory": true,
"dueDate": "2026-01-01T00:00:00.000Z",
"dueDateDuration": 1,
"dueDateDurationUnit": 1,
"dueDateSet": true,
"entries": [
"text"
],
"evidenceData": {
"customFields": "[Circular Reference]",
"description": "[Circular Reference]",
"occurred": "[Circular Reference]",
"tags": "[Circular Reference]"
},
"executionCount": 1,
"externalFormUseAuth": true,
"fieldMapping": [
"[Circular Reference]"
],
"forEachIndex": 1,
"forEachInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{}
]
},
"form": {
"description": "text",
"expired": true,
"questions": "[Circular Reference]",
"sender": "text",
"title": "text",
"totalAnswers": 1
},
"formDisplay": {
"bodyBackgroundColor": "text",
"bodyFontColor": "text",
"headerBackgroundColor": "text",
"headerFontColor": "text",
"isExternalRtl": true,
"sender": "text",
"submitButtonBackgroundColor": "text",
"submitButtonFontColor": "text",
"submitText": "text"
},
"hasErrorEntries": true,
"id": "text",
"ignoreWorker": true,
"indent": 1,
"input": "text",
"isAutoSwitchedToQuietMode": true,
"isOverSize": true,
"loop": {
"brand": "text",
"builtinCondition": "[Circular Reference]",
"exitCondition": "text",
"forEach": true,
"isCommand": true,
"max": 1,
"scriptArguments": "[Circular Reference]",
"scriptId": "text",
"scriptName": "text",
"wait": 1
},
"message": {
"bcc": "[Circular Reference]",
"body": "[Circular Reference]",
"cc": "[Circular Reference]",
"defaultOption": "text",
"format": "text",
"methods": [
"text"
],
"replyOptions": [
"text"
],
"subject": "[Circular Reference]",
"timings": {
"completeAfterReplies": 1,
"completeAfterSLA": true,
"completeAfterV2": true,
"retriesCount": 1,
"retriesInterval": 1
},
"to": "[Circular Reference]"
},
"missingContentItem": "text",
"nextPollingTime": "2026-01-01T00:00:00.000Z",
"nextTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"note": true,
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"parentBlockCount": 1,
"parentPlaybookID": "text",
"patched": true,
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"pollingEntries": [
"text"
],
"pollingTimeoutTime": "2026-01-01T00:00:00.000Z",
"previousTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"quietMode": 1,
"reminder": 1,
"reputationCalc": 1,
"restrictedCompletion": true,
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"separateContext": true,
"skip": true,
"skipUnavailable": true,
"sla": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"slaReminder": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"startDate": "2026-01-01T00:00:00.000Z",
"startedExecutingHarmfulScript": true,
"state": "text",
"subPlaybook": {
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": "[Circular Reference]",
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": "[Circular Reference]",
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": "[Circular Reference]",
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": "[Circular Reference]",
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
},
"task": {
"brand": "text",
"cacheVersn": 1,
"clonedFrom": "text",
"comment": "text",
"conditions": [
"text"
],
"created": "2026-01-01T00:00:00.000Z",
"description": "text",
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"isCommand": true,
"isLocked": true,
"isTitleTask": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"playbookId": "text",
"playbookName": "text",
"primaryTerm": 1,
"scriptId": "text",
"sequenceNumber": 1,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"tags": [
"text"
],
"type": "text",
"version": 1
},
"taskCompleteData": [
{
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"calculatedDescription": "text",
"calculatedTaskName": "text",
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"entries": [
"text"
],
"hasErrorEntries": true,
"input": "text",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"startDate": "2026-01-01T00:00:00.000Z",
"state": "text",
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
],
"taskDebug": {
"breakpointCondition": "[Circular Reference]",
"inputOverrides": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"isMarkedWithBreakpoint": true,
"isMarkedWithSkip": true,
"outputOverrides": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"shouldOverrideDebugInfo": true,
"skipConditionOverrideTo": "text",
"taskOriginalId": "text"
},
"taskId": "text",
"taskSize": 1,
"timerTriggers": [
{
"action": "text",
"fieldName": "text"
}
],
"timesPolled": 1,
"type": "text",
"view": {},
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
},
"view": {}
}
],
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
]
},
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": {
"ANY_ADDITIONAL_PROPERTY": {
"Reopen": true,
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"assignee": "text",
"assigneeSet": true,
"blockingTasks": [
"text"
],
"calculatedDescription": "text",
"calculatedTaskName": "text",
"comments": true,
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"conditions": [
{
"condition": [
"[Circular Reference]"
],
"label": "text"
}
],
"continueOnError": true,
"continueOnErrorType": "text",
"defaultAssignee": "text",
"defaultAssigneeComplex": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"defaultReminder": 1,
"doNotSaveTaskHistory": true,
"dueDate": "2026-01-01T00:00:00.000Z",
"dueDateDuration": 1,
"dueDateDurationUnit": 1,
"dueDateSet": true,
"entries": [
"text"
],
"evidenceData": {
"customFields": "[Circular Reference]",
"description": "[Circular Reference]",
"occurred": "[Circular Reference]",
"tags": "[Circular Reference]"
},
"executionCount": 1,
"externalFormUseAuth": true,
"fieldMapping": [
{
"fieldId": "text",
"output": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
}
}
],
"forEachIndex": 1,
"forEachInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{}
]
},
"form": {
"description": "text",
"expired": true,
"questions": "[Circular Reference]",
"sender": "text",
"title": "text",
"totalAnswers": 1
},
"formDisplay": {
"bodyBackgroundColor": "text",
"bodyFontColor": "text",
"headerBackgroundColor": "text",
"headerFontColor": "text",
"isExternalRtl": true,
"sender": "text",
"submitButtonBackgroundColor": "text",
"submitButtonFontColor": "text",
"submitText": "text"
},
"hasErrorEntries": true,
"id": "text",
"ignoreWorker": true,
"indent": 1,
"input": "text",
"isAutoSwitchedToQuietMode": true,
"isOverSize": true,
"loop": {
"brand": "text",
"builtinCondition": "[Circular Reference]",
"exitCondition": "text",
"forEach": true,
"isCommand": true,
"max": 1,
"scriptArguments": "[Circular Reference]",
"scriptId": "text",
"scriptName": "text",
"wait": 1
},
"message": {
"bcc": "[Circular Reference]",
"body": "[Circular Reference]",
"cc": "[Circular Reference]",
"defaultOption": "text",
"format": "text",
"methods": [
"text"
],
"replyOptions": [
"text"
],
"subject": "[Circular Reference]",
"timings": {
"completeAfterReplies": 1,
"completeAfterSLA": true,
"completeAfterV2": true,
"retriesCount": 1,
"retriesInterval": 1
},
"to": "[Circular Reference]"
},
"missingContentItem": "text",
"nextPollingTime": "2026-01-01T00:00:00.000Z",
"nextTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"note": true,
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"parentBlockCount": 1,
"parentPlaybookID": "text",
"patched": true,
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"pollingEntries": [
"text"
],
"pollingTimeoutTime": "2026-01-01T00:00:00.000Z",
"previousTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"quietMode": 1,
"reminder": 1,
"reputationCalc": 1,
"restrictedCompletion": true,
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"separateContext": true,
"skip": true,
"skipUnavailable": true,
"sla": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"slaReminder": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"startDate": "2026-01-01T00:00:00.000Z",
"startedExecutingHarmfulScript": true,
"state": "text",
"subPlaybook": {
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": "[Circular Reference]",
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": "[Circular Reference]",
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": "[Circular Reference]",
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": "[Circular Reference]",
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
},
"task": {
"brand": "text",
"cacheVersn": 1,
"clonedFrom": "text",
"comment": "text",
"conditions": [
"text"
],
"created": "2026-01-01T00:00:00.000Z",
"description": "text",
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"isCommand": true,
"isLocked": true,
"isTitleTask": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"playbookId": "text",
"playbookName": "text",
"primaryTerm": 1,
"scriptId": "text",
"sequenceNumber": 1,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"tags": [
"text"
],
"type": "text",
"version": 1
},
"taskCompleteData": [
{
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"calculatedDescription": "text",
"calculatedTaskName": "text",
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"entries": [
"text"
],
"hasErrorEntries": true,
"input": "text",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"startDate": "2026-01-01T00:00:00.000Z",
"state": "text",
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
],
"taskDebug": {
"breakpointCondition": "[Circular Reference]",
"inputOverrides": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"isMarkedWithBreakpoint": true,
"isMarkedWithSkip": true,
"outputOverrides": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"shouldOverrideDebugInfo": true,
"skipConditionOverrideTo": "text",
"taskOriginalId": "text"
},
"taskId": "text",
"taskSize": 1,
"timerTriggers": [
{
"action": "text",
"fieldName": "text"
}
],
"timesPolled": 1,
"type": "text",
"view": {},
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
},
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
}Import and override playbook in Cortex XSOAR
Authorizations
AuthorizationstringRequired
Body
filestringOptional
file
Responses
200
The saved playbook
application/json
warningsstring[]Optional
post/playbook/save/yaml
POST /playbook/save/yaml HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 15
{
"file": "text"
}200
The saved playbook
{
"playbook": {
"allRead": true,
"allReadWrite": true,
"brands": [
"text"
],
"cacheVersn": 1,
"commands": [
"text"
],
"comment": "text",
"commitMessage": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"definitionId": "text",
"deprecated": true,
"detached": true,
"encTasks": "text",
"fromServerVersion": {
"Digits": [
1
],
"Label": "text"
},
"hasRole": true,
"hidden": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"inputs": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": "[Circular Reference]",
"root": "text",
"transformers": "[Circular Reference]"
},
"keyValue": [
"[Circular Reference]"
],
"simple": "text"
}
}
],
"itemVersion": {
"Digits": [
1
],
"Label": "text"
},
"locked": true,
"missingScriptsIds": [
"text"
],
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"nameRaw": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"packID": "text",
"packName": "text",
"packPropagationLabels": [
"text"
],
"prevName": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"private": true,
"propagationLabels": [
"text"
],
"quiet": true,
"remote": true,
"roles": [
"text"
],
"scriptIds": [
"text"
],
"sequenceNumber": 1,
"shouldCommit": true,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"sourcePlaybookID": "text",
"startTaskId": "text",
"syncHash": "text",
"system": true,
"tags": [
"text"
],
"taskIds": [
"text"
],
"tasks": {
"ANY_ADDITIONAL_PROPERTY": {
"conditions": [
{
"condition": "[Circular Reference]",
"label": "text"
}
],
"continueOnError": true,
"continueOnErrorType": "text",
"defaultAssignee": "text",
"defaultAssigneeComplex": {
"complex": {
"accessor": "text",
"filters": "[Circular Reference]",
"root": "text",
"transformers": "[Circular Reference]"
},
"keyValue": [
"[Circular Reference]"
],
"simple": "text"
},
"defaultReminder": 1,
"evidenceData": {
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"description": {
"complex": {
"accessor": "text",
"filters": "[Circular Reference]",
"root": "text",
"transformers": "[Circular Reference]"
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"occurred": {
"complex": {
"accessor": "text",
"filters": "[Circular Reference]",
"root": "text",
"transformers": "[Circular Reference]"
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"tags": {
"complex": {
"accessor": "text",
"filters": "[Circular Reference]",
"root": "text",
"transformers": "[Circular Reference]"
},
"keyValue": "[Circular Reference]",
"simple": "text"
}
},
"externalFormUseAuth": true,
"fieldMapping": [
{
"fieldId": "text",
"output": "[Circular Reference]"
}
],
"form": {
"description": "text",
"expired": true,
"questions": [
"[Circular Reference]"
],
"sender": "text",
"title": "text",
"totalAnswers": 1
},
"formDisplay": {
"bodyBackgroundColor": "text",
"bodyFontColor": "text",
"headerBackgroundColor": "text",
"headerFontColor": "text",
"isExternalRtl": true,
"sender": "text",
"submitButtonBackgroundColor": "text",
"submitButtonFontColor": "text",
"submitText": "text"
},
"id": "text",
"ignoreWorker": true,
"isAutoSwitchedToQuietMode": true,
"isOverSize": true,
"loop": {
"brand": "text",
"builtinCondition": [
"[Circular Reference]"
],
"exitCondition": "text",
"forEach": true,
"isCommand": true,
"max": 1,
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"scriptId": "text",
"scriptName": "text",
"wait": 1
},
"message": {
"bcc": {
"complex": {
"accessor": "text",
"filters": "[Circular Reference]",
"root": "text",
"transformers": "[Circular Reference]"
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"body": {
"complex": {
"accessor": "text",
"filters": "[Circular Reference]",
"root": "text",
"transformers": "[Circular Reference]"
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"cc": {
"complex": {
"accessor": "text",
"filters": "[Circular Reference]",
"root": "text",
"transformers": "[Circular Reference]"
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"defaultOption": "text",
"format": "text",
"methods": [
"text"
],
"replyOptions": [
"text"
],
"subject": {
"complex": {
"accessor": "text",
"filters": "[Circular Reference]",
"root": "text",
"transformers": "[Circular Reference]"
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"timings": {
"completeAfterReplies": 1,
"completeAfterSLA": true,
"completeAfterV2": true,
"retriesCount": 1,
"retriesInterval": 1
},
"to": {
"complex": {
"accessor": "text",
"filters": "[Circular Reference]",
"root": "text",
"transformers": "[Circular Reference]"
},
"keyValue": "[Circular Reference]",
"simple": "text"
}
},
"nextTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"note": true,
"quietMode": 1,
"reputationCalc": 1,
"restrictedCompletion": true,
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": {
"complex": {
"accessor": "text",
"filters": "[Circular Reference]",
"root": "text",
"transformers": "[Circular Reference]"
},
"keyValue": "[Circular Reference]",
"simple": "text"
}
},
"separateContext": true,
"skipUnavailable": true,
"sla": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"slaReminder": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"task": {
"brand": "text",
"cacheVersn": 1,
"clonedFrom": "text",
"comment": "text",
"conditions": [
"text"
],
"created": "2026-01-01T00:00:00.000Z",
"description": "text",
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"isCommand": true,
"isLocked": true,
"isTitleTask": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"playbookId": "text",
"playbookName": "text",
"primaryTerm": 1,
"scriptId": "text",
"sequenceNumber": 1,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"tags": [
"text"
],
"type": "text",
"version": 1
},
"taskId": "text",
"timerTriggers": [
{
"action": "text",
"fieldName": "text"
}
],
"type": "text",
"view": {}
}
},
"toServerVersion": {
"Digits": [
1
],
"Label": "text"
},
"vcShouldIgnore": true,
"vcShouldKeepItemLegacyProdMachine": true,
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
},
"warnings": [
"text"
]
}Complete a task with command and multiple file attachments
Authorizations
AuthorizationstringRequired
Body
investigationIdstringOptional
investigation ID
taskIdstringOptional
Task Id
taskCommentstringOptional
Task comment or command to run
taskInputstringOptional
Task input
versionstringOptional
Version
filestringOptional
Files to attach to the task
fileNamesstringOptional
file names separated by %###% (only if files provided)
fileCommentsstringOptional
file comment separated by %###% (only if files provided)
Responses
200
InvestigationPlaybook
application/json
InvestigationPlaybook is a wrapper for a linked list of Playbook tasks
DirtybooleanOptional
ReplacedPlaybookbooleanOptional
Indicate whether this playbook has new history during this session
ShardIDinteger · int64Optional
UpdatedOperatorIDsbooleanOptional
allReadbooleanOptional
allReadWritebooleanOptional
autoExtractingbooleanOptional
cacheVersninteger · int64Optional
commentstringOptional
createdstring · date-timeOptional
dbotCreatedBystringOptional
Who has created this event - relevant only for manual incidents
hasRolebooleanOptional
Internal field to make queries on role faster
idstringOptional
incidentCreateDatestring · date-timeOptional
Incident create date
indexNamestringOptional
investigationIdstringOptional
isTIMbooleanOptional
modifiedstring · date-timeOptional
namestringOptional
numericIdinteger · int64Optional
playbookIdstringOptional
previousAllReadbooleanOptional
previousAllReadWritebooleanOptional
previousRolesstring[]Optional
Do not change this field manually
primaryTerminteger · int64Optional
quietbooleanOptional
recoveryAttemptsinteger · int64Optional
rolesstring[]Optional
The role assigned to this investigation
sequenceNumberinteger · int64Optional
serverIdstringOptional
Holds the ID of the responsible cluster app server
sizeInBytesinteger · int64Optional
sortValuesstring[]Optional
startDatestring · date-timeOptional
startTaskIdstringOptional
FirstTask is the root task of the playbook
statestringOptional
InvestigationPlaybookState indicates the state of the running playbook
syncHashstringOptional
versioninteger · int64Optional
viewobject · PlaybookViewOptional
PlaybookView represents the view in client of playbook graph
xsoarHasReadOnlyRolebooleanOptional
xsoarPreviousReadOnlyRolesstring[]Optional
xsoarReadOnlyRolesstring[]Optional
post/v2/inv-playbook/task/complete
POST /v2/inv-playbook/task/complete HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 154
{
"investigationId": "text",
"taskId": "text",
"taskComment": "text",
"taskInput": "text",
"version": "text",
"file": "text",
"fileNames": "text",
"fileComments": "text"
}200
InvestigationPlaybook
{
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
],
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": [
{
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"autoExtracting": true,
"comment": "text",
"inputs": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
],
"investigationId": "text",
"isTIM": true,
"name": "text",
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"quiet": true,
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
]
},
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"tasks": {
"ANY_ADDITIONAL_PROPERTY": {
"Reopen": true,
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"assignee": "text",
"assigneeSet": true,
"blockingTasks": [
"text"
],
"calculatedDescription": "text",
"calculatedTaskName": "text",
"comments": true,
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"conditions": [
"[Circular Reference]"
],
"continueOnError": true,
"continueOnErrorType": "text",
"defaultAssignee": "text",
"defaultAssigneeComplex": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"defaultReminder": 1,
"doNotSaveTaskHistory": true,
"dueDate": "2026-01-01T00:00:00.000Z",
"dueDateDuration": 1,
"dueDateDurationUnit": 1,
"dueDateSet": true,
"entries": [
"text"
],
"evidenceData": {
"customFields": "[Circular Reference]",
"description": "[Circular Reference]",
"occurred": "[Circular Reference]",
"tags": "[Circular Reference]"
},
"executionCount": 1,
"externalFormUseAuth": true,
"fieldMapping": [
"[Circular Reference]"
],
"forEachIndex": 1,
"forEachInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{}
]
},
"form": {
"description": "text",
"expired": true,
"questions": "[Circular Reference]",
"sender": "text",
"title": "text",
"totalAnswers": 1
},
"formDisplay": {
"bodyBackgroundColor": "text",
"bodyFontColor": "text",
"headerBackgroundColor": "text",
"headerFontColor": "text",
"isExternalRtl": true,
"sender": "text",
"submitButtonBackgroundColor": "text",
"submitButtonFontColor": "text",
"submitText": "text"
},
"hasErrorEntries": true,
"id": "text",
"ignoreWorker": true,
"indent": 1,
"input": "text",
"isAutoSwitchedToQuietMode": true,
"isOverSize": true,
"loop": {
"brand": "text",
"builtinCondition": "[Circular Reference]",
"exitCondition": "text",
"forEach": true,
"isCommand": true,
"max": 1,
"scriptArguments": "[Circular Reference]",
"scriptId": "text",
"scriptName": "text",
"wait": 1
},
"message": {
"bcc": "[Circular Reference]",
"body": "[Circular Reference]",
"cc": "[Circular Reference]",
"defaultOption": "text",
"format": "text",
"methods": [
"text"
],
"replyOptions": [
"text"
],
"subject": "[Circular Reference]",
"timings": {
"completeAfterReplies": 1,
"completeAfterSLA": true,
"completeAfterV2": true,
"retriesCount": 1,
"retriesInterval": 1
},
"to": "[Circular Reference]"
},
"missingContentItem": "text",
"nextPollingTime": "2026-01-01T00:00:00.000Z",
"nextTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"note": true,
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"parentBlockCount": 1,
"parentPlaybookID": "text",
"patched": true,
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"pollingEntries": [
"text"
],
"pollingTimeoutTime": "2026-01-01T00:00:00.000Z",
"previousTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"quietMode": 1,
"reminder": 1,
"reputationCalc": 1,
"restrictedCompletion": true,
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"separateContext": true,
"skip": true,
"skipUnavailable": true,
"sla": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"slaReminder": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"startDate": "2026-01-01T00:00:00.000Z",
"startedExecutingHarmfulScript": true,
"state": "text",
"subPlaybook": {
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": "[Circular Reference]",
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": "[Circular Reference]",
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": "[Circular Reference]",
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": "[Circular Reference]",
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
},
"task": {
"brand": "text",
"cacheVersn": 1,
"clonedFrom": "text",
"comment": "text",
"conditions": [
"text"
],
"created": "2026-01-01T00:00:00.000Z",
"description": "text",
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"isCommand": true,
"isLocked": true,
"isTitleTask": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"playbookId": "text",
"playbookName": "text",
"primaryTerm": 1,
"scriptId": "text",
"sequenceNumber": 1,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"tags": [
"text"
],
"type": "text",
"version": 1
},
"taskCompleteData": [
{
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"calculatedDescription": "text",
"calculatedTaskName": "text",
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"entries": [
"text"
],
"hasErrorEntries": true,
"input": "text",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"startDate": "2026-01-01T00:00:00.000Z",
"state": "text",
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
],
"taskDebug": {
"breakpointCondition": "[Circular Reference]",
"inputOverrides": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"isMarkedWithBreakpoint": true,
"isMarkedWithSkip": true,
"outputOverrides": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"shouldOverrideDebugInfo": true,
"skipConditionOverrideTo": "text",
"taskOriginalId": "text"
},
"taskId": "text",
"taskSize": 1,
"timerTriggers": [
{
"action": "text",
"fieldName": "text"
}
],
"timesPolled": 1,
"type": "text",
"view": {},
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
},
"view": {}
}
],
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
]
},
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": {
"ANY_ADDITIONAL_PROPERTY": {
"Reopen": true,
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"assignee": "text",
"assigneeSet": true,
"blockingTasks": [
"text"
],
"calculatedDescription": "text",
"calculatedTaskName": "text",
"comments": true,
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"conditions": [
{
"condition": [
"[Circular Reference]"
],
"label": "text"
}
],
"continueOnError": true,
"continueOnErrorType": "text",
"defaultAssignee": "text",
"defaultAssigneeComplex": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"defaultReminder": 1,
"doNotSaveTaskHistory": true,
"dueDate": "2026-01-01T00:00:00.000Z",
"dueDateDuration": 1,
"dueDateDurationUnit": 1,
"dueDateSet": true,
"entries": [
"text"
],
"evidenceData": {
"customFields": "[Circular Reference]",
"description": "[Circular Reference]",
"occurred": "[Circular Reference]",
"tags": "[Circular Reference]"
},
"executionCount": 1,
"externalFormUseAuth": true,
"fieldMapping": [
{
"fieldId": "text",
"output": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
}
}
],
"forEachIndex": 1,
"forEachInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{}
]
},
"form": {
"description": "text",
"expired": true,
"questions": "[Circular Reference]",
"sender": "text",
"title": "text",
"totalAnswers": 1
},
"formDisplay": {
"bodyBackgroundColor": "text",
"bodyFontColor": "text",
"headerBackgroundColor": "text",
"headerFontColor": "text",
"isExternalRtl": true,
"sender": "text",
"submitButtonBackgroundColor": "text",
"submitButtonFontColor": "text",
"submitText": "text"
},
"hasErrorEntries": true,
"id": "text",
"ignoreWorker": true,
"indent": 1,
"input": "text",
"isAutoSwitchedToQuietMode": true,
"isOverSize": true,
"loop": {
"brand": "text",
"builtinCondition": "[Circular Reference]",
"exitCondition": "text",
"forEach": true,
"isCommand": true,
"max": 1,
"scriptArguments": "[Circular Reference]",
"scriptId": "text",
"scriptName": "text",
"wait": 1
},
"message": {
"bcc": "[Circular Reference]",
"body": "[Circular Reference]",
"cc": "[Circular Reference]",
"defaultOption": "text",
"format": "text",
"methods": [
"text"
],
"replyOptions": [
"text"
],
"subject": "[Circular Reference]",
"timings": {
"completeAfterReplies": 1,
"completeAfterSLA": true,
"completeAfterV2": true,
"retriesCount": 1,
"retriesInterval": 1
},
"to": "[Circular Reference]"
},
"missingContentItem": "text",
"nextPollingTime": "2026-01-01T00:00:00.000Z",
"nextTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"note": true,
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"parentBlockCount": 1,
"parentPlaybookID": "text",
"patched": true,
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"pollingEntries": [
"text"
],
"pollingTimeoutTime": "2026-01-01T00:00:00.000Z",
"previousTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"quietMode": 1,
"reminder": 1,
"reputationCalc": 1,
"restrictedCompletion": true,
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"separateContext": true,
"skip": true,
"skipUnavailable": true,
"sla": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"slaReminder": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"startDate": "2026-01-01T00:00:00.000Z",
"startedExecutingHarmfulScript": true,
"state": "text",
"subPlaybook": {
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": "[Circular Reference]",
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": "[Circular Reference]",
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": "[Circular Reference]",
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": "[Circular Reference]",
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
},
"task": {
"brand": "text",
"cacheVersn": 1,
"clonedFrom": "text",
"comment": "text",
"conditions": [
"text"
],
"created": "2026-01-01T00:00:00.000Z",
"description": "text",
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"isCommand": true,
"isLocked": true,
"isTitleTask": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"playbookId": "text",
"playbookName": "text",
"primaryTerm": 1,
"scriptId": "text",
"sequenceNumber": 1,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"tags": [
"text"
],
"type": "text",
"version": 1
},
"taskCompleteData": [
{
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"calculatedDescription": "text",
"calculatedTaskName": "text",
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"entries": [
"text"
],
"hasErrorEntries": true,
"input": "text",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"startDate": "2026-01-01T00:00:00.000Z",
"state": "text",
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
],
"taskDebug": {
"breakpointCondition": "[Circular Reference]",
"inputOverrides": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"isMarkedWithBreakpoint": true,
"isMarkedWithSkip": true,
"outputOverrides": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"shouldOverrideDebugInfo": true,
"skipConditionOverrideTo": "text",
"taskOriginalId": "text"
},
"taskId": "text",
"taskSize": 1,
"timerTriggers": [
{
"action": "text",
"fieldName": "text"
}
],
"timesPolled": 1,
"type": "text",
"view": {},
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
},
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
}Submit a data collection task with given answers and multiple file attachments
Authorizations
AuthorizationstringRequired
Body
investigationIdstringOptional
investigation ID
taskIdstringOptional
Task Id
answersstringOptional
the answers to the task form. Answers are keyed by numerical question id
filestringOptional
Files to attach to the task
Responses
200
InvestigationPlaybook
application/json
InvestigationPlaybook is a wrapper for a linked list of Playbook tasks
DirtybooleanOptional
ReplacedPlaybookbooleanOptional
Indicate whether this playbook has new history during this session
ShardIDinteger · int64Optional
UpdatedOperatorIDsbooleanOptional
allReadbooleanOptional
allReadWritebooleanOptional
autoExtractingbooleanOptional
cacheVersninteger · int64Optional
commentstringOptional
createdstring · date-timeOptional
dbotCreatedBystringOptional
Who has created this event - relevant only for manual incidents
hasRolebooleanOptional
Internal field to make queries on role faster
idstringOptional
incidentCreateDatestring · date-timeOptional
Incident create date
indexNamestringOptional
investigationIdstringOptional
isTIMbooleanOptional
modifiedstring · date-timeOptional
namestringOptional
numericIdinteger · int64Optional
playbookIdstringOptional
previousAllReadbooleanOptional
previousAllReadWritebooleanOptional
previousRolesstring[]Optional
Do not change this field manually
primaryTerminteger · int64Optional
quietbooleanOptional
recoveryAttemptsinteger · int64Optional
rolesstring[]Optional
The role assigned to this investigation
sequenceNumberinteger · int64Optional
serverIdstringOptional
Holds the ID of the responsible cluster app server
sizeInBytesinteger · int64Optional
sortValuesstring[]Optional
startDatestring · date-timeOptional
startTaskIdstringOptional
FirstTask is the root task of the playbook
statestringOptional
InvestigationPlaybookState indicates the state of the running playbook
syncHashstringOptional
versioninteger · int64Optional
viewobject · PlaybookViewOptional
PlaybookView represents the view in client of playbook graph
xsoarHasReadOnlyRolebooleanOptional
xsoarPreviousReadOnlyRolesstring[]Optional
xsoarReadOnlyRolesstring[]Optional
post/v2/inv-playbook/task/form/submit
POST /v2/inv-playbook/task/form/submit HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 73
{
"investigationId": "text",
"taskId": "text",
"answers": "text",
"file": "text"
}200
InvestigationPlaybook
{
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
],
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": [
{
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"autoExtracting": true,
"comment": "text",
"inputs": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
],
"investigationId": "text",
"isTIM": true,
"name": "text",
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"quiet": true,
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
]
},
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"tasks": {
"ANY_ADDITIONAL_PROPERTY": {
"Reopen": true,
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"assignee": "text",
"assigneeSet": true,
"blockingTasks": [
"text"
],
"calculatedDescription": "text",
"calculatedTaskName": "text",
"comments": true,
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"conditions": [
"[Circular Reference]"
],
"continueOnError": true,
"continueOnErrorType": "text",
"defaultAssignee": "text",
"defaultAssigneeComplex": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"defaultReminder": 1,
"doNotSaveTaskHistory": true,
"dueDate": "2026-01-01T00:00:00.000Z",
"dueDateDuration": 1,
"dueDateDurationUnit": 1,
"dueDateSet": true,
"entries": [
"text"
],
"evidenceData": {
"customFields": "[Circular Reference]",
"description": "[Circular Reference]",
"occurred": "[Circular Reference]",
"tags": "[Circular Reference]"
},
"executionCount": 1,
"externalFormUseAuth": true,
"fieldMapping": [
"[Circular Reference]"
],
"forEachIndex": 1,
"forEachInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{}
]
},
"form": {
"description": "text",
"expired": true,
"questions": "[Circular Reference]",
"sender": "text",
"title": "text",
"totalAnswers": 1
},
"formDisplay": {
"bodyBackgroundColor": "text",
"bodyFontColor": "text",
"headerBackgroundColor": "text",
"headerFontColor": "text",
"isExternalRtl": true,
"sender": "text",
"submitButtonBackgroundColor": "text",
"submitButtonFontColor": "text",
"submitText": "text"
},
"hasErrorEntries": true,
"id": "text",
"ignoreWorker": true,
"indent": 1,
"input": "text",
"isAutoSwitchedToQuietMode": true,
"isOverSize": true,
"loop": {
"brand": "text",
"builtinCondition": "[Circular Reference]",
"exitCondition": "text",
"forEach": true,
"isCommand": true,
"max": 1,
"scriptArguments": "[Circular Reference]",
"scriptId": "text",
"scriptName": "text",
"wait": 1
},
"message": {
"bcc": "[Circular Reference]",
"body": "[Circular Reference]",
"cc": "[Circular Reference]",
"defaultOption": "text",
"format": "text",
"methods": [
"text"
],
"replyOptions": [
"text"
],
"subject": "[Circular Reference]",
"timings": {
"completeAfterReplies": 1,
"completeAfterSLA": true,
"completeAfterV2": true,
"retriesCount": 1,
"retriesInterval": 1
},
"to": "[Circular Reference]"
},
"missingContentItem": "text",
"nextPollingTime": "2026-01-01T00:00:00.000Z",
"nextTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"note": true,
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"parentBlockCount": 1,
"parentPlaybookID": "text",
"patched": true,
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"pollingEntries": [
"text"
],
"pollingTimeoutTime": "2026-01-01T00:00:00.000Z",
"previousTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"quietMode": 1,
"reminder": 1,
"reputationCalc": 1,
"restrictedCompletion": true,
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"separateContext": true,
"skip": true,
"skipUnavailable": true,
"sla": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"slaReminder": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"startDate": "2026-01-01T00:00:00.000Z",
"startedExecutingHarmfulScript": true,
"state": "text",
"subPlaybook": {
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": "[Circular Reference]",
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": "[Circular Reference]",
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": "[Circular Reference]",
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": "[Circular Reference]",
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
},
"task": {
"brand": "text",
"cacheVersn": 1,
"clonedFrom": "text",
"comment": "text",
"conditions": [
"text"
],
"created": "2026-01-01T00:00:00.000Z",
"description": "text",
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"isCommand": true,
"isLocked": true,
"isTitleTask": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"playbookId": "text",
"playbookName": "text",
"primaryTerm": 1,
"scriptId": "text",
"sequenceNumber": 1,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"tags": [
"text"
],
"type": "text",
"version": 1
},
"taskCompleteData": [
{
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"calculatedDescription": "text",
"calculatedTaskName": "text",
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"entries": [
"text"
],
"hasErrorEntries": true,
"input": "text",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"startDate": "2026-01-01T00:00:00.000Z",
"state": "text",
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
],
"taskDebug": {
"breakpointCondition": "[Circular Reference]",
"inputOverrides": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"isMarkedWithBreakpoint": true,
"isMarkedWithSkip": true,
"outputOverrides": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"shouldOverrideDebugInfo": true,
"skipConditionOverrideTo": "text",
"taskOriginalId": "text"
},
"taskId": "text",
"taskSize": 1,
"timerTriggers": [
{
"action": "text",
"fieldName": "text"
}
],
"timesPolled": 1,
"type": "text",
"view": {},
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
},
"view": {}
}
],
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"description": "text",
"key": "text",
"playbookInputQuery": {
"fromDate": "2026-01-01T00:00:00.000Z",
"fromDateLicense": "2026-01-01T00:00:00.000Z",
"period": {
"by": "text",
"byFrom": "text",
"byTo": "text",
"field": "text",
"fromValue": "text",
"toValue": "text"
},
"query": "text",
"queryEntity": "text",
"queryState": {
"batchSize": 1,
"currentPage": 1,
"searchAfter": [
"text"
],
"totalResults": 1
},
"results": {},
"runFromLastJobTime": true,
"toDate": "2026-01-01T00:00:00.000Z"
},
"required": true,
"value": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": [
{
"key": "text",
"value": "[Circular Reference]"
}
],
"simple": "text"
}
}
]
},
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": {
"ANY_ADDITIONAL_PROPERTY": {
"Reopen": true,
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"assignee": "text",
"assigneeSet": true,
"blockingTasks": [
"text"
],
"calculatedDescription": "text",
"calculatedTaskName": "text",
"comments": true,
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"conditions": [
{
"condition": [
"[Circular Reference]"
],
"label": "text"
}
],
"continueOnError": true,
"continueOnErrorType": "text",
"defaultAssignee": "text",
"defaultAssigneeComplex": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
},
"defaultReminder": 1,
"doNotSaveTaskHistory": true,
"dueDate": "2026-01-01T00:00:00.000Z",
"dueDateDuration": 1,
"dueDateDurationUnit": 1,
"dueDateSet": true,
"entries": [
"text"
],
"evidenceData": {
"customFields": "[Circular Reference]",
"description": "[Circular Reference]",
"occurred": "[Circular Reference]",
"tags": "[Circular Reference]"
},
"executionCount": 1,
"externalFormUseAuth": true,
"fieldMapping": [
{
"fieldId": "text",
"output": {
"complex": {
"accessor": "text",
"filters": [
"[Circular Reference]"
],
"root": "text",
"transformers": [
"[Circular Reference]"
]
},
"keyValue": "[Circular Reference]",
"simple": "text"
}
}
],
"forEachIndex": 1,
"forEachInputs": {
"ANY_ADDITIONAL_PROPERTY": [
{}
]
},
"form": {
"description": "text",
"expired": true,
"questions": "[Circular Reference]",
"sender": "text",
"title": "text",
"totalAnswers": 1
},
"formDisplay": {
"bodyBackgroundColor": "text",
"bodyFontColor": "text",
"headerBackgroundColor": "text",
"headerFontColor": "text",
"isExternalRtl": true,
"sender": "text",
"submitButtonBackgroundColor": "text",
"submitButtonFontColor": "text",
"submitText": "text"
},
"hasErrorEntries": true,
"id": "text",
"ignoreWorker": true,
"indent": 1,
"input": "text",
"isAutoSwitchedToQuietMode": true,
"isOverSize": true,
"loop": {
"brand": "text",
"builtinCondition": "[Circular Reference]",
"exitCondition": "text",
"forEach": true,
"isCommand": true,
"max": 1,
"scriptArguments": "[Circular Reference]",
"scriptId": "text",
"scriptName": "text",
"wait": 1
},
"message": {
"bcc": "[Circular Reference]",
"body": "[Circular Reference]",
"cc": "[Circular Reference]",
"defaultOption": "text",
"format": "text",
"methods": [
"text"
],
"replyOptions": [
"text"
],
"subject": "[Circular Reference]",
"timings": {
"completeAfterReplies": 1,
"completeAfterSLA": true,
"completeAfterV2": true,
"retriesCount": 1,
"retriesInterval": 1
},
"to": "[Circular Reference]"
},
"missingContentItem": "text",
"nextPollingTime": "2026-01-01T00:00:00.000Z",
"nextTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"note": true,
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"parentBlockCount": 1,
"parentPlaybookID": "text",
"patched": true,
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"pollingEntries": [
"text"
],
"pollingTimeoutTime": "2026-01-01T00:00:00.000Z",
"previousTasks": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"quietMode": 1,
"reminder": 1,
"reputationCalc": 1,
"restrictedCompletion": true,
"scriptArguments": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"separateContext": true,
"skip": true,
"skipUnavailable": true,
"sla": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"slaReminder": {
"days": 1,
"hours": 1,
"minutes": 1,
"weeks": 1
},
"startDate": "2026-01-01T00:00:00.000Z",
"startedExecutingHarmfulScript": true,
"state": "text",
"subPlaybook": {
"Dirty": true,
"ReadyPlaybookInputs": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"ReplacedPlaybook": true,
"ShardID": 1,
"UpdatedOperatorIDs": true,
"allRead": true,
"allReadWrite": true,
"autoExtracting": true,
"cacheVersn": 1,
"comment": "text",
"created": "2026-01-01T00:00:00.000Z",
"dbotCreatedBy": "text",
"hasRole": true,
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"incidentCreateDate": "2026-01-01T00:00:00.000Z",
"indexName": "text",
"inputs": "[Circular Reference]",
"invPBDebugInfo": {
"originalInvPBId": "text"
},
"investigationId": "text",
"isTIM": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"outputs": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
],
"pbHistory": "[Circular Reference]",
"pendingTasks": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookId": "text",
"previousAllRead": true,
"previousAllReadWrite": true,
"previousRoles": [
"text"
],
"primaryTerm": 1,
"quiet": true,
"recoveryAttempts": 1,
"roles": [
"text"
],
"sequenceNumber": 1,
"serverId": "text",
"sizeInBytes": 1,
"sortValues": [
"text"
],
"startDate": "2026-01-01T00:00:00.000Z",
"startTaskId": "text",
"state": "text",
"subPlaybookInputs": "[Circular Reference]",
"subPlaybookOutputs": {
"ANY_ADDITIONAL_PROPERTY": [
{
"contextPath": "text",
"description": "text",
"type": "text"
}
]
},
"syncHash": "text",
"tasks": "[Circular Reference]",
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
},
"task": {
"brand": "text",
"cacheVersn": 1,
"clonedFrom": "text",
"comment": "text",
"conditions": [
"text"
],
"created": "2026-01-01T00:00:00.000Z",
"description": "text",
"highlight": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"id": "text",
"indexName": "text",
"isCommand": true,
"isLocked": true,
"isTitleTask": true,
"modified": "2026-01-01T00:00:00.000Z",
"name": "text",
"numericId": 1,
"playbookId": "text",
"playbookName": "text",
"primaryTerm": 1,
"scriptId": "text",
"sequenceNumber": 1,
"sizeInBytes": 1,
"sortValues": [
"text"
],
"syncHash": "text",
"tags": [
"text"
],
"type": "text",
"version": 1
},
"taskCompleteData": [
{
"arguments": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"calculatedDescription": "text",
"calculatedTaskName": "text",
"completedBy": "text",
"completedCount": 1,
"completedDate": "2026-01-01T00:00:00.000Z",
"entries": [
"text"
],
"hasErrorEntries": true,
"input": "text",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"playbookInputs": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"startDate": "2026-01-01T00:00:00.000Z",
"state": "text",
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
],
"taskDebug": {
"breakpointCondition": "[Circular Reference]",
"inputOverrides": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"isMarkedWithBreakpoint": true,
"isMarkedWithSkip": true,
"outputOverrides": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"shouldOverrideDebugInfo": true,
"skipConditionOverrideTo": "text",
"taskOriginalId": "text"
},
"taskId": "text",
"taskSize": 1,
"timerTriggers": [
{
"action": "text",
"fieldName": "text"
}
],
"timesPolled": 1,
"type": "text",
"view": {},
"willNotExecuteCount": 1,
"willNotExecuteReason": "text"
}
},
"version": 1,
"view": {},
"xsoarHasReadOnlyRole": true,
"xsoarPreviousReadOnlyRoles": [
"text"
],
"xsoarReadOnlyRoles": [
"text"
]
}Last updated
Was this helpful?