SUBSET

Used in

Servers

Metadata (Browse)

Parent elements

Syntax

<SUBSET	Attribute Description Table
*(r)docid="string"* (r)type="children \| parents \| siblings \| ancestors \| descendants" > No Child Elements </SUBSET >
(r): Attribute or child element is required.

Description

Specifies a subset of the documents in the metadata repository to be searched.

Notes

By default, all documents in a metadata repository are searched. When SUBSET is included, docid specifies the "from" document of the search, and type specifies the relation of the desired documents to the "from" document. For example, if docid identifies a folder and type is "descendants", any document contained in any folder within the identified folder may be returned.

Attribute Descriptions for SUBSET

Attribute	Usage
docid	String used to uniquely identify a document. The client used to publish the metadata is responsible for creating the document ID. This ID is automatically assigned when using ArcCatalog. If another client is used, GET_UUID can be used to request a valid ID. The format for an ID is the following: {HHHHHHHH-HHHH-HHHH-HHHH-HHHHHHHHHHHH} where H is a hexadecimal digit (0-9,a-f,A-F). The ID is limited to 38 characters.
type	Target document's relationship to the source document. "ancestors": finds folders that contain the document and folder with the docid; the Metadata Service's root document is also returned. "children": finds documents and folders immediately contained by the folder with thedocid; for example, if folder B is contained by folder A and folder A is identified by the docid, folder B is returned but no documents or folders contained by folder B are returned. "descendants": finds documents and folders contained anywhere under the folder with the docid; for example, every document is a descendant of the Metadata Service's root document. "parents": finds the folder containing the document and folder with the docid; the Metadata Service's root document is returned for documents that are not stored within a folder. "siblings": finds documents that are semantically related to the document with the docid; for example, siblings to the current document are shown as related documents in the Details page in Metadata Explorer. Sibling relationships are defined manually in ArcCatalog, for example, between resources related to one project.

Attribute

Usage

docid

String used to uniquely identify a document. The client used to publish the metadata is responsible for creating the document ID. This ID is automatically assigned when using ArcCatalog. If another client is used, GET_UUID can be used to request a valid ID. The format for an ID is the following:
{HHHHHHHH-HHHH-HHHH-HHHH-HHHHHHHHHHHH}
where H is a hexadecimal digit (0-9,a-f,A-F). The ID is limited to 38 characters.

type

Target document's relationship to the source document.

"ancestors": finds folders that contain the document and folder with the docid; the Metadata Service's root document is also returned.
"children": finds documents and folders immediately contained by the folder with thedocid; for example, if folder B is contained by folder A and folder A is identified by the docid, folder B is returned but no documents or folders contained by folder B are returned.
"descendants": finds documents and folders contained anywhere under the folder with the docid; for example, every document is a descendant of the Metadata Service's root document.
"parents": finds the folder containing the document and folder with the docid; the Metadata Service's root document is returned for documents that are not stored within a folder.
"siblings": finds documents that are semantically related to the document with the docid; for example, siblings to the current document are shown as related documents in the Details page in Metadata Explorer. Sibling relationships are defined manually in ArcCatalog, for example, between resources related to one project.

Examples for SUBSET

<?xml version="1.0" encoding="UTF-8" ?>
<ARCXML version="1.1">
  <REQUEST>
    <GET_METADATA>
      <SEARCH_METADATA>
        <SEARCH_METADATA>
          <SUBSET type="children" docid="{F7DDF21-BC01-4C20-8AA5-243B33ED0B1E}" />
        </SEARCH_METADATA>
      <SEARCH_METADATA>
   </GET_METADATA>
  </REQUEST>
</ARCXML>