Query: Find Workbook

Tableau Operation

The Find Workbook query searches for and locates a specific workbook in Tableau.

Example User Story

I want to retrieve a specific workbook from Tableau Server so that I can analyze its contents.

Fields

Field Name	Field Type	Required
workbookId	String	Yes

Related Connections

Tableau

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "find-workbook",
  "state": "inDev",
  "meta": {
    "short": "Find Workbook",
    "description": "Retrieves a specific workbook from Tableau Server or Tableau Cloud."
  },
  "input": [
    {
      "name": "workbookId",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The ID of the workbook to retrieve."
      }
    }
  ],
  "output": [
    {
      "name": "workbook",
      "type": "Object",
      "selector": ["workbook"],
      "meta": {
        "description": "The retrieved workbook object."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "GET",
        "path": {
          "value": "/api/3.12/sites/{{siteId}}/workbooks/{{workbookId}}",
          "placeholders": [
            {
              "name": "siteId",
              "type": "String",
              "description": "The ID of the site where the workbook is located.",
              "required": true
            },
            {
              "name": "workbookId",
              "type": "String",
              "description": "The ID of the workbook to retrieve.",
              "required": true
            }
          ]
        },
        "headers": {
          "Accept": {
            "value": "application/json"
          }
        }
      }
    }
  ]
}