Requesting xProperty Information
Copy
You can use the selected attribute’s extended syntax to get more information about defined xProperties. Use ‘xp-*’ to get all the xProperties defined for an item. You can also request additional information about xProperties by including the following special values in your request.
Select=”xp-cost” returns a value
Select=”xp-cost($value)” returns the monetary value associated with an item.
Select=”xp-cost(permission_id)” returns the permission ID attribute but does not return a value.
Select=”xp-*(@defined_as)” returns all defined xProperties but does not return a value.
The following example retrieves all Parts from the database. The response also includes the item_number and all defined xProperties:
Query:
<AML>
<Item type="Part” action="get” select="item_number, xp-*(@defined_as)"></Item>
</AML>
Return:
Only the xp-length is defined on this Part. The Value is not provided because we do
not provide $value in select for xp-*(…)
<Result>
<Item type="Part” typeId="3B135425…" id="0FA8ED…">
<item_number>999-888</item_number>
<xp-length defined_as="class” is_null="0"/>
</Item>
xp-length, xp-width and xp-height are defined on this Part
<Item type="Part” typeId="4B135425…" id="1FA8ED…">
<item_number>999-777</item_number>
<xp-length defined_as="class” is_null="0"/>
<xp-width defined_as="class|explicit” is_null="0"/>
<xp-height defined_as="explicit” is_null="0"/>
</Item>
</Result>
The following example shows the information request for an item’s defined xProperties:
Query:
<Item type="Part” action="get” select="item_number, xp-cost($value, @permission_id, @explicit), xp-length($value, @permission_id, @explicit)">
</Item>
xp-cost is defined explicitly and does not have private permission
Return:
<Result>
<Item type="Part” typeId="3B135425…" id="0FA8ED…">
<item_number>999-888</item_number>
<xp-cost explicit=“1">10</xp-cost>
<xp-length permission_id="123...” explicit="0" />10<xp-length>
</Item>
xp-length is not defined explicitly and has private permission (123…)
</Result>
The following example shows the request for information about an item’s defined xProperty:
Query:
<Item type="Part” action="get” select="item_number, xp-*($value, @defined_as)"/>