> For the complete documentation index, see [llms.txt](https://www.opal-rt.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.opal-rt.com/docs/rt-lab/automation-api-and-scripting/rt-lab-api/c-rt-lab-api-reference/functions-reference/opalcommand.md).

# OpalCommand

<table data-header-hidden><thead><tr><th width="199.77783203125"></th><th></th></tr></thead><tbody><tr><td><strong>Group</strong></td><td>Generic</td></tr><tr><td><strong>Description</strong></td><td>Run an RT-LAB command for a certain RT-Lab object.<br>See the <strong>OP_COMMAND</strong> enumeration for a complete list of available commands and their specific requirements.</td></tr><tr><td><strong>Required Control</strong></td><td>Specific to each command, see <strong>OP_COMMAND</strong>.</td></tr><tr><td><strong>Usage</strong></td><td>int <strong>OpalCommand</strong> (OP_REF_ID ownerId, <strong>OP_COMMAND</strong> command, int numAttributesIn,<strong>OP_ATTRIBUTE</strong> attributes[], void * attributeValues[], OP_REF_ID * outputId)</td></tr><tr><td><strong>Input</strong></td><td><ul><li><strong>ownerId:</strong> The ID of the object that owns the command. Where there is ambiguity, the owner of the two objects is the expected ID. For example CMD_REMOVE: when the owner is a project, the command removes a model.</li><li><strong>command:</strong> The command to be executed</li><li><strong>numAttributes:</strong> The number of attributes to send as arguments for the command.</li><li><strong>attributes:</strong> The array of attributes to send to the command. The size of the array must be equal to the numAttributes argument. May be NULL is numAttributes is 0.</li><li><strong>attributeValues:</strong> The pointer to the array of values to be used as arguments for the command. The type of each value must correspond to the attribute of the same index in attributes. The size of the array must be equal to the numAttributes argument. May be NULL is numAttributes is 0.</li></ul></td></tr><tr><td><strong>Output</strong></td><td><strong>outputId</strong> The ID corresponding to the object directly affected by the command. If no other object than the parent is affected, the parent ID is returned.</td></tr><tr><td><strong>Return value</strong></td><td><ul><li><strong>EOK:</strong> Success.</li><li><strong>EBADF:</strong> Unsupported ownerId.</li><li><strong>EINVAL:</strong> Invalid arguments specified.</li><li><strong>EIO:</strong> Error sending the request or receiving the reply.</li><li><strong>ENOMEM:</strong> Error allocation memory for request or reply.</li></ul></td></tr><tr><td><strong>Examples</strong></td><td>None.</td></tr><tr><td><strong>Related items</strong></td><td>OP_COMMAND, OP_ATTRIBUTE.</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://www.opal-rt.com/docs/rt-lab/automation-api-and-scripting/rt-lab-api/c-rt-lab-api-reference/functions-reference/opalcommand.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
