> Markdown versions of all pages of this connector library are available by appending `.md` to the page URL. For the full index of connectors, see [llms.txt](https://connectors.appmixer.com/llms.txt).

# Run Report

- Component: `appmixer.workday.core.RunReport`
- Kind: Action
- Version: 1.0.0
- Visibility: Public
- Connector: [appmixer.workday 1.0.0](https://connectors.appmixer.com/connector/appmixer.workday/1.0.0.md)
- Component page: <https://connectors.appmixer.com/connector/appmixer.workday/1.0.0/component/appmixer.workday.core.RunReport>

Run a custom report enabled as a web service (Reports-as-a-Service) and return its rows as JSON. The report must be shared with the account the connector uses.

## Input ports

### Port `in`

| Field | Type | Description |
| --- | --- | --- |
| Report Owner (`reportOwner`) | text | Username of the report owner as it appears in the report's web service URL, e.g. `lmcneil` in `.../customreport2/acme/lmcneil/Workers_Report`. |
| Report Name (`reportName`) | text | Report name as it appears in the report's web service URL, e.g. `Workers_Report`. |
| Report Prompts (`parameters`) | key-value | Optional report prompts as query parameters, e.g. `Effective_as_of_Date` = `2026-01-31-08:00`. |

## Output ports

### Port `out`

| Field | Type | Description |
| --- | --- | --- |
| Rows (`result`) | array | - |
| Rows Count (`count`) | integer | - |

## Full metadata (component.json)

```json
{
  "name": "appmixer.workday.core.RunReport",
  "label": "Run Report",
  "description": "Run a custom report enabled as a web service (Reports-as-a-Service) and return its rows as JSON. The report must be shared with the account the connector uses.",
  "author": "Appmixer <info@appmixer.com>",
  "version": "1.0.0",
  "auth": {
    "service": "appmixer:workday"
  },
  "quota": {
    "manager": "appmixer:workday",
    "resources": "requests",
    "scope": {
      "userId": "{{userId}}"
    }
  },
  "inPorts": [
    {
      "name": "in",
      "schema": {
        "type": "object",
        "properties": {
          "reportOwner": {
            "type": "string"
          },
          "reportName": {
            "type": "string"
          },
          "parameters": {
            "type": "string"
          }
        },
        "required": [
          "reportOwner",
          "reportName"
        ]
      },
      "inspector": {
        "inputs": {
          "reportOwner": {
            "type": "text",
            "index": 1,
            "label": "Report Owner",
            "tooltip": "Username of the report owner as it appears in the report's web service URL, e.g. <code>lmcneil</code> in <code>.../customreport2/acme/lmcneil/Workers_Report</code>."
          },
          "reportName": {
            "type": "text",
            "index": 2,
            "label": "Report Name",
            "tooltip": "Report name as it appears in the report's web service URL, e.g. <code>Workers_Report</code>."
          },
          "parameters": {
            "type": "key-value",
            "keyLabel": "Prompt",
            "valueLabel": "Value",
            "addLabel": "Add prompt",
            "removeLabel": "Remove prompt",
            "index": 3,
            "label": "Report Prompts",
            "tooltip": "Optional report prompts as query parameters, e.g. <code>Effective_as_of_Date</code> = <code>2026-01-31-08:00</code>."
          }
        }
      }
    }
  ],
  "outPorts": [
    {
      "name": "out",
      "schema": {
        "type": "object",
        "required": [
          "result",
          "count"
        ],
        "properties": {
          "result": {
            "type": "array",
            "title": "Rows",
            "items": {
              "type": "object",
              "properties": {}
            },
            "example": [
              {
                "Worker": "Logan McNeil",
                "Employee_ID": "21001"
              }
            ]
          },
          "count": {
            "type": "integer",
            "title": "Rows Count",
            "example": 1
          }
        }
      }
    }
  ],
  "icon": "(data URI omitted)"
}
```
