# Get Object Status

This is a pre-built Action located under the **@Custom Element**. The functionality of this Action in Avo Assure is to retrieve the status of the specified object. The result is stored in the given dynamic variable for further use during test execution.

{% hint style="info" %}
The **Get Object Status** action works only when the **VerifyExists** action is executed in a preceding step.
{% endhint %}

## Syntax

**Input Value**: `<ObjectType>;<VisibleText(Optional)>;<Index>;<abs(optional)>`

| Argument                            | Description                                                                                                                                            |
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| <p>\<ObjectType><br>(Required)</p>  | Provide the type of object whose status you want to retrieved.                                                                                         |
| <p>\<VisibleText><br>(Optional)</p> | Provide the visible text associated with the object.                                                                                                   |
| <p>\<Index><br>(Required)</p>       | <p>Provide the position of the object you want to identify based on its sequence in the application.<br><strong>Note</strong>: Index start from 0.</p> |
| <p>\<abs><br>(Optional)</p>         | Provide the absolute XPath of the object you want to identify for this operation.                                                                      |

{% hint style="info" %}
**Note**:

* If the last argument **abs** is defined, the action executes using absolute identification based on the specified absolute XPath provided in the input.
* To skip an optional input value, use an extra semicolon (;).
  {% endhint %}

**Output Value**: `<Dynamic Variable>;<Dynamic Variable>(Optional)`

| Argument                                 | Description                                                      |
| ---------------------------------------- | ---------------------------------------------------------------- |
| <p>\<Dynamic Variable><br>(Required)</p> | This dynamic variable stores the retrieved status of the object. |
| <p>\<Dynamic Variable><br>(Optional)</p> | This dynamic variable stores the status of the object.           |

### **Example 1: Retrieving the Status of a UI Element**

In this example, we are explaining how to fetch the current status of a specified object in the application.

* **Action**: Get Object Status
* **Input Value**: button;;0
  * The first argument (**button**) specifies the object type to be identified.
  * The second argument is left blank to skip an optional value.
  * The third argument (**0**) specifies the index of the object when multiple matching elements are present.
* **Output Value:** {Object}
  * The retrieved object status (Enabled / Visible / Exists) is stored in the **{Object}** dynamic variable.
  * If a second output variable is defined, it stores the action status with the following possible values:
    * **True**: If the object status is retrieved successfully.
    * **False**: If the object status is not retrieved successfully.
* **Logical Explanation**: The **Get Object Status** action reads the identification details from the **Input Value** column (**button;;0**). The action locates the matching UI element based on the specified object type and index and retrieves the current status of the object, such as whether it is enabled, visible, or exists. The retrieved status (Enabled) is stored in the **{Object}** variable.

<figure><img src="/files/SsfZ7y8UcaK3aqkfvJt4" alt=""><figcaption></figcaption></figure>

### **Example 2: Retrieving the Status of a UI Element using Optional Parameters**

In this example, we are explaining how to fetch the current status of a specified object in the application using optional identification parameters.

* **Action**: Get Object Status
* **Input Value**: button;Double Click;2;//\*\[@id="dzOQY"]
  * The first argument (**button**) specifies the object type to be identified.
  * The second argument (**Double Click**) specifies the visible text of the object.
  * The third argument (**2**) specifies the index of the object when multiple matching elements are present.
  * The fourth argument (**//\*\[@id="dzOQY"]**) specifies the absolute XPath of the object.
* **Output Value**: {Object}
  * The retrieved object status (Enabled / Visible / Exists) is stored in the **{Object}** dynamic variable.
  * If a second output variable is defined, it stores the action status with the following possible values:
    * **True**: If the object status is retrieved successfully.
    * **False**: If the object status is not retrieved successfully.
* **Logical Explanation**: The **Get Object Status** action reads the identification details from the **Input Value** column (**button;Double Click;2;//\*\[@id="dzOQY"]**). The action locates the matching UI element based on the specified object type, visible text, index, and absolute XPath and retrieves the current status of the object, such as whether it is enabled, visible, or exists. The retrieved status (Enabled) is stored in the **{Object}** variable.

<figure><img src="/files/W2toiynCqmbz3najmvdf" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.avoautomation.com/avo-assure/actions/web/custom-1/get-object-status.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.