Filtering a GetMetadataObjects Request

AssociationPath Component Syntax

The AssociationPath component enables you to specify one or more associations as search criteria. To be selected, the objects specified in the Object component must have an association that meets the criteria in AssociationPath.

The syntax of AssociationPath is as follows:

Object[AssociationPath][AssociationPathn]

Each AssociationPath is the following:

[AssociationPathLevel/AssociationPathLeveln]

And, AssociationPathLevel is the following:

AssociationName/AssociatedObject[AttributeCriteria]

In the syntax, Object can be a metadata type name or an asterisk, as described in Object Component Syntax.

Each AssociationPath specifies one association of Object to evaluate. Specifying two AssociationPath components concatenates the criteria and indicates that two associations will be evaluated. Specifying a third AssociationPath indicates that three associations will be evaluated. The brackets enclosing each AssociationPath are required and function like an AND operator.

An AssociationPath specification can include one or more association path levels. The first AssociationPathLevel identifies the association of Object that will be evaluated. Subsequent levels are supported to enable you to filter the objects that are returned for this first association by specifying additional associations, associated metadata types, and attribute criteria that the first set of objects must match in order to be selected. For more information, see Understanding an Association Path. Each AssociationPathLevel within the AssociationPath is separated from the other levels by a slash (/).

AttributeCriteria is optional in a AssociationPathLevel.

Top of Page