Skip to main content
Skip table of contents

Get Playbook Tasks Metadata

READER NOTE

This utility command is for 16.8+, if you are in a lower version, you may encounter limitations in accessing this command. Kindly reach out to D3 for assistance in obtaining access if such a situation arises.

Retrieve metadata of all the playbook tasks presented in a live version playbook.

Implementation

Python

Command Category

System Utility

Tags

N/A

Inputs

Parameter Name

Required/Optional

Description

Sample Data

Playbook Type

Required

Identify the playbook type, which can be event, incident and codeless playbook.

Event Playbook

Playbook Name

Required

The name of the playbook from which the task metadata will be retrieved.

PlaybookName

Integration Name

Option

Require if the codeless playbook is an integration codeless playbook.

IntegrationName

Output

Return Data

The returned result of this command. If some required parameters are not defined, this returned data could be empty. The returned result can be passed down directly to a subsequent command in playbooks.

SAMPLE DATA

JSON
{
  "Status": "Successful",
  "Data": [
			{
				"TaskName": "CommandTask",
				"TaskId": *****
				"TaskType": "Command Task",
				"TaskConfig": {
					"IntegrationName": "IntegrationName",
					"CommandName": "CommandName",
					"Connection": "C",
					"Input settings": {},
				},
				"BasicConfig": {
					"Active": True,
					"AutoRun": True,
					"LongRun": True,
					"Required": True,
					"AssignedTo": "abc",
					"DueTime": "",
					"RunMode": "",
					"Description":"",
					"ErrorTrigger": True,
					"StopOnError": False,
					"RerunBy": "name",
					"Auto-RetryOnError": True,
					"Auto-RetryOnErrorSetting": {
						"Retries": 4,
						"RetriesSetting": [
						"10s", "3m", "1h"
						]
					}
				}
			}
		]
}

Remote Command API

The D3 command API allows you to send requests to D3 SOAR to execute this utility command via REST API.

Request

POST

CODE
https://{base_url}/{api_namespace}/api/Command/GetPlaybookTasksMetadata

Headers

Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.

Request Body

JSON
{
  "Username": <Username here>,
  "Site": <Site here>,
  "CommandParams": {
    "Playbook Type": <Playbook Type here>,
    "Playbook Name": <Playbook Name here>,
    "Integration Name": <Integration Name here>,
  }
}

Body Parameters

Parameter Name

Type

Required/Optional

Description

Username

Text

Required

The username of your D3 SOAR account.

Site

Text

Required

The D3 SOAR site to run the remote command.

Playbook Type

Text

Required

Identify the playbook type, which can be event, incident and codeless playbook.

Playbook Name

Text

Required

The name of the playbook from which the task metadata will be retrieved.

Integration Name

Number

Optional

Require if the codeless playbook is an integration codeless playbook.

Sample Request

SAMPLE DATA

JSON
{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Playbook Type": "Event Playbook",
    "Playbook Name": "PlaybookName",
    "Integration Name": "IntegrationName"
  }
}

Response

Response Fields

Field Name

Type

Description

error

Text

The error message if the API request has failed.

returnData

Text

The return data from the API request.

Sample Response

JSON
{
    "error": "",
    "returnData": {
        "Status": "Successful",
        "Data": [
            {
                "TaskName": "CommandTask",
                "TaskId": "*****",
                "TaskType": "Command Task",
                "TaskConfig": {
                    "IntegrationName": "IntegrationName",
                    "CommandName": "CommandName",
                    "Connection": "C",
                    "Input settings": {}
                },
                "BasicConfig": {
                    "Active": true,
                    "AutoRun": true,
                    "LongRun": true,
                    "Required": true,
                    "AssignedTo": "abc",
                    "DueTime": "",
                    "RunMode": "",
                    "Description": "",
                    "ErrorTrigger": true,
                    "StopOnError": false,
                    "RerunBy": "name",
                    "Auto-RetryOnError": true,
                    "Auto-RetryOnErrorSetting": {
                        "Retries": 4,
                        "RetriesSetting": [
                            "10s",
                            "3m",
                            "1h"
                        ]
                    }
                }
            }
        ]
    }
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.