x_path Property

Provides a way to point to a specific element in the response.

Syntax

def get_x_path() -> str: ...
def set_x_path(value: str) -> None: ...

x_path = property(get_x_path, set_x_path)

Default Value

""

Remarks

This property provides a way to point to a specific element in the response. This property implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML documents.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current x_path location.

The following are possible values for an element accessor:

'name'A particular element name.
[i]The i-th subelement of the current element.
..the parent of the current element.

When x_path is set to a valid path, x_element points to the name of the element, with x_parent, x_namespace, x_prefix, x_children, and x_text providing other properties of the element. The attributes of the current element will be contained in the attributes properties.

build_dom must be set to True prior to parsing the document for the x_path functionality to be available.

Example (Setting XPath)

Document rootRestControl.XPath = "/"
Specific ElementRestControl.XPath = "/root/SubElement1/SubElement2/"
i-th ChildRestControl.XPath = "/root/[i]"

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 Python Edition - Version 20.0 [Build 8307]