Skip to content

1.0.1 Overview

A resource is identified by:

  • A name.

  • A label.

  • A unique Uniform Resource Identifier (URI) that defines the location of the resource in the repository. A URI is similar to a Unix path (for example, /reports/samples/AllAccounts).

    A resource can have a set of properties (depending on its type) and a set of children resources.

    The resource descriptor is a complex structure that transfers data regarding a specific resource between the server and the client. A request can include only one resource descriptor. Often, the request only includes a small portion of the entire resource descriptor definition: the part that describes the specific details of the resource in question.

    For example, when a resourceDescriptor is used as an input parameter in a request document (for example, to specify a folder to list or a file to download), the descriptor includes only a small portion of the entire resource descriptor definition: the part that describes the specific resource details in question. In many cases, the only information required to identify a resource in the repository is its wsType, name, and URI.

    The resource descriptors that the server sends are completely populated with all the data about the resources being described.

    A resourceDescriptor tag is defined by the following DTD (Document Type Definition):

    <!ELEMENT resourceDescriptor (label, description?, resourceProperty, resourceDescriptor, parameter)>
<!ATTLIST resourceDescriptor
  name CDATA #REQUIRED
  wsType CDATA #REQUIRED
  uriString CDATA #REQUIRED
  isNew ( true | false ) false
>
<!ELEMENT resourceProperty (value?, resourceProperty)>
<!ATTLIST resourceProperty
  name CDATA #REQUIRED
>
<!ELEMENT value (#PCDATA)>
<!ELEMENT parameter (#PCDATA)>
<!ATTLIST parameter
  name CDATA #REQUIRED
  isListItem ( true | false ) false
>

    The following sections describe the DTD:

  • wsType Attribute

  • isNew Attribute

  • Resource Descriptor Parameters

  • Examples of resourceDescriptor