Skip to main content
Skip table of contents

Get PDF File Content

Get all text and Urls in a PDF file based on file id and source.

Implementation

System

Command Category

System Utility

Tags

PLAYBOOK

Inputs

Parameter Name

Required/Optional

Description

Sample Data

File Id

Required

Id of the file to get content

1

File Source

Required

Source of the file

Playbook File

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
{
    "text": "The Number  of Event by Techniques (Bar Chart) 23",
    "urls": [
        "https://www.google.com",
        "https://www.bing.com/"
    ]
}

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

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": {
    "File Id": <File Id here>,
    "File Source": <File Source 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.

File Id

Text

Required

Id of the file to get content

File Source

Text

Required

Source of the file

Sample Request

SAMPLE DATA

JSON
{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "File Id": 1,
    "File Source": "Playbook File"
  }
}

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": {
      "text": "The Number  of Event by Techniques (Bar Chart) 23",
      "urls": [
          "https://www.google.com",
          "https://www.bing.com/"
      ]
    }
}
JavaScript errors detected

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

If this problem persists, please contact our support.