Showing:

Annotations
Attributes
Diagrams
Facets
Model
Properties
Source
Used by
Element irm:RelatedResourcesType / irm:link
Namespace urn:us:gov:ic:irm
Annotations
Diagram
Properties
Source
Schema location IC-IRM.xsd Copy and paste this link to your file browser, clicking the link MAY open in the browser. Opening in an XML aware editor is best.
Complex Type irm:RelatedResourcesType
Namespace urn:us:gov:ic:irm
Annotations
?

The type entity used by the irm:relationship element. Each irm:relatedResource element designates the relationship and the directionality of the relationship between the resource described by the parent irm:Resource and any irm:RelatedResource elements.

Diagram
Diagram IC-IRM_xsd_Complex_Type_irm_CompoundResourceIdentifierType.tmp#CompoundResourceIdentifierType_qualifier IC-IRM_xsd_Complex_Type_irm_CompoundResourceIdentifierType.tmp#CompoundResourceIdentifierType_value IC-IRM_xsd_Complex_Type_irm_CompoundResourceIdentifierType.tmp#CompoundResourceIdentifierType IC-IRM_xsd_Complex_Type_irm_RelatedResourcesType.tmp#RelatedResourcesType_relationship IC-IRM_xsd_Complex_Type_irm_RelatedResourcesType.tmp#RelatedResourcesType_direction IC-IRM_xsd_Attribute_Group_irm_SecurityAttributesOptionGroup.tmp#urn_us_gov_ic_irm_SecurityAttributesOptionGroup IC-IRM_xsd_Complex_Type_irm_RelatedResourcesType.tmp#RelatedResourcesType_link
Type extension of irm:CompoundResourceIdentifierType
Type hierarchy
Used by
Model
Children irm:link
Attributes
QName Type Default Use Annotation
SchemaguideSecurityAttributesOptionGroup xsd:NMTOKEN optional
This attribute is only a placeholder so that all the ISM attributes are not shown in the schemaGuide for every element. If you refer to the documentation of the attribute group it will say what attributes should be here.
irm:direction restriction of xsd:string outbound optional
?

ded:Definition: An attribute of relatedResource used to indicate the direction of the relationship between the resource being described and the target related resource. Valid values are ?inbound,? ?outbound,? and ?bidirectional.?

ded:Obligation: (Optional)

ded:Comment: Inbound: Used to indicate that the relationship direction is from the related resource to the resource being described. Outbound: Used to indicate that the relationship direction is from the resource being described to the related resource identified. Outbound is the default value. Bidirectional: Used to indicate that the relationship is bidirectional between the resource being described and the related resource identified.

irm:qualifier xsd:anyURI required

ded:Definition: An attribute of identifier and relatedResource that contains a URI specifying the formal identification system or encoding scheme by which the identifier value is to be interpreted.

ded:Obligation: (Mandatory)

ded:Comment: Specifies the type of identifier or relatedResource that is supplied in the identifier or relatedResource value.

irm:relationship xsd:anyURI required
?

ded:Definition: An attribute of relatedResource, relationship is a URI defining the type of relationship between the resource being described as the primary subject of the metadata card and the resource referenced by this element. Represents a relationship of some relationship type between the resource described by the parent irm:Resource element and another resource or resources.

ded:Obligation: (Conditional) Mandatory if relatedResource is present.

ded:Comment: URIs representing relationships should be controlled by relationship type taxonomies that are registered.

irm:value irm:simpleTokenType required

ded:Definition: An attribute of identifier and relatedResource that contains an unambiguous reference to the resource within a given context. An internal, external, and/or universal identification number for a data asset or resource.

ded:Obligation: (Mandatory)

ded:Comment: Permissible values must conform to the value supplied in identifier and relatedResource qualifier.

Source
<xsd:complexType name="RelatedResourcesType">
  <xsd:annotation>
    <xsd:documentation>&#x2028;
      <p xmlns="http://www.w3.org/1999/xhtml" ism:ownerProducer="USA" ism:classification="U">The type entity used by the irm:relationship element. Each irm:relatedResource element designates the relationship and the directionality of the relationship between the resource described by the parent irm:Resource and any irm:RelatedResource elements.</p>
    </xsd:documentation>
  </xsd:annotation>
  <xsd:complexContent>
    <xsd:extension base="irm:CompoundResourceIdentifierType">
      <xsd:sequence>
        <xsd:element name="link" maxOccurs="unbounded">
          <xsd:annotation>
            <xsd:documentation>&#x2028;
              <p xmlns="http://www.w3.org/1999/xhtml" ism:classification="U" ism:ownerProducer="USA" data-ded="ded:Definition">ded:Definition: An xLink:locatorLink element under relatedResource for the resource being related.</p>
              <p xmlns="http://www.w3.org/1999/xhtml" ism:classification="U" ism:ownerProducer="USA" data-ded="ded:Obligation">ded:Obligation: (Conditional) Mandatory if relatedResource is present.</p>
              <p xmlns="http://www.w3.org/1999/xhtml" ism:classification="U" ism:ownerProducer="USA" data-ded="ded:Comment">ded:Comment: An XLink locator element, see also http://www.w3.org/TR/xlink/</p>
            </xsd:documentation>
          </xsd:annotation>
          <xsd:complexType>
            <xsd:attributeGroup ref="xlink:locatorAttrs">
              <xsd:annotation>
                <xsd:documentation>&#x2028;
                  <p xmlns="http://www.w3.org/1999/xhtml" ism:classification="U" ism:ownerProducer="USA" data-ded="ded:Definition">ded:Definition: type: An attribute of link that identifies the type of xlink element for this irm:link. The value for the link type attribute is fixed to ?locator.? In IRM this value indicates that the href attribute value addresses the remote resource being related. href: An attribute of link that specifies a URL to the target related resource. role: An attribute of link, role is a URI reference that identifies some resource that describes the intended property. When no value is supplied, no particular role value is to be inferred. title: An attribute of link used to describe the meaning of a link or resource in a human-readable format, along the same lines as the role or arcrole attribute. label: An attribute of link that provides a name for the locator link, providing a way for an XLink arc-type element to refer to it in creating a traversal arc.</p>
                  <p xmlns="http://www.w3.org/1999/xhtml" ism:classification="U" ism:ownerProducer="USA" data-ded="ded:Obligation">ded:Obligation: type: (Mandatory) href: (Mandatory) role: (Optional) title: (Optional) label: (Optional)</p>
                  <p xmlns="http://www.w3.org/1999/xhtml" ism:classification="U" ism:ownerProducer="USA" data-ded="ded:Comment">ded:Comment: type: This attribute is fixed as ?locator? for the irm:link element. See also, http://www.w3.org/TR/xlink/#remote-resource href: See also, http://www.w3.org/TR/xlink/#link-locators. role: See also, http://www.w3.org/TR/xlink/#link-semantics. title: See also, http://www.w3.org/TR/xlink/#link-semantics. lable: See also, http://www.w3.org/TR/xlink/#traversal-atts</p>
                </xsd:documentation>
              </xsd:annotation>
            </xsd:attributeGroup>
          </xsd:complexType>
        </xsd:element>
      </xsd:sequence>
      <xsd:attribute name="relationship" type="xsd:anyURI" use="required">
        <xsd:annotation>
          <xsd:documentation>&#x2028;
            <p xmlns="http://www.w3.org/1999/xhtml" ism:classification="U" ism:ownerProducer="USA" data-ded="ded:Definition">ded:Definition: An attribute of relatedResource, relationship is a URI defining the type of relationship between the resource being described as the primary subject of the metadata card and the resource referenced by this element. Represents a relationship of some relationship type between the resource described by the parent irm:Resource element and another resource or resources.</p>
            <p xmlns="http://www.w3.org/1999/xhtml" ism:classification="U" ism:ownerProducer="USA" data-ded="ded:Obligation">ded:Obligation: (Conditional) Mandatory if relatedResource is present.</p>
            <p xmlns="http://www.w3.org/1999/xhtml" ism:classification="U" ism:ownerProducer="USA" data-ded="ded:Comment">ded:Comment: URIs representing relationships should be controlled by relationship type taxonomies that are registered.</p>
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>
      <xsd:attribute name="direction" use="optional" default="outbound">
        <xsd:annotation>
          <xsd:documentation>&#x2028;
            <p xmlns="http://www.w3.org/1999/xhtml" ism:classification="U" ism:ownerProducer="USA" data-ded="ded:Definition">ded:Definition: An attribute of relatedResource used to indicate the direction of the relationship between the resource being described and the target related resource. Valid values are ?inbound,? ?outbound,? and ?bidirectional.?</p>
            <p xmlns="http://www.w3.org/1999/xhtml" ism:classification="U" ism:ownerProducer="USA" data-ded="ded:Obligation">ded:Obligation: (Optional)</p>
            <p xmlns="http://www.w3.org/1999/xhtml" ism:classification="U" ism:ownerProducer="USA" data-ded="ded:Comment">ded:Comment: Inbound: Used to indicate that the relationship direction is from the related resource to the resource being described. Outbound: Used to indicate that the relationship direction is from the resource being described to the related resource identified. Outbound is the default value. Bidirectional: Used to indicate that the relationship is bidirectional between the resource being described and the related resource identified.</p>
          </xsd:documentation>
        </xsd:annotation>
        <xsd:simpleType>
          <xsd:restriction base="xsd:string">
            <xsd:enumeration value="inbound">
              <xsd:annotation>
                <xsd:documentation>&#x2028;
                  <p xmlns="http://www.w3.org/1999/xhtml" ism:ownerProducer="USA" ism:classification="U">Used to indicate that the relationship direction is from the related resource to the resource described in the instance IRM record.</p>
                </xsd:documentation>
              </xsd:annotation>
            </xsd:enumeration>
            <xsd:enumeration value="outbound">
              <xsd:annotation>
                <xsd:documentation>&#x2028;
                  <p xmlns="http://www.w3.org/1999/xhtml" ism:ownerProducer="USA" ism:classification="U">Used to indicate that the relationship direction is from the resource described in the instance IRM record to the related resource identified.</p>
                </xsd:documentation>
              </xsd:annotation>
            </xsd:enumeration>
            <xsd:enumeration value="bidirectional">
              <xsd:annotation>
                <xsd:documentation>&#x2028;
                  <p xmlns="http://www.w3.org/1999/xhtml" ism:ownerProducer="USA" ism:classification="U">Used to indicate that the relationship is bidirectional between the resource described in the instance IRM record and the related resource identified.</p>
                </xsd:documentation>
              </xsd:annotation>
            </xsd:enumeration>
          </xsd:restriction>
        </xsd:simpleType>
      </xsd:attribute>
      <xsd:attributeGroup ref="irm:SecurityAttributesOptionGroup"/>
    </xsd:extension>
  </xsd:complexContent>
</xsd:complexType>
Schema location IC-IRM.xsd Copy and paste this link to your file browser, clicking the link MAY open in the browser. Opening in an XML aware editor is best.
Attribute irm:RelatedResourcesType / @irm:relationship
Namespace urn:us:gov:ic:irm
Annotations
?

ded:Definition: An attribute of relatedResource, relationship is a URI defining the type of relationship between the resource being described as the primary subject of the metadata card and the resource referenced by this element. Represents a relationship of some relationship type between the resource described by the parent irm:Resource element and another resource or resources.

ded:Obligation: (Conditional) Mandatory if relatedResource is present.

ded:Comment: URIs representing relationships should be controlled by relationship type taxonomies that are registered.

Type xsd:anyURI
Properties
use required
Used by
Source
<xsd:attribute name="relationship" type="xsd:anyURI" use="required">
  <xsd:annotation>
    <xsd:documentation>&#x2028;
      <p xmlns="http://www.w3.org/1999/xhtml" ism:classification="U" ism:ownerProducer="USA" data-ded="ded:Definition">ded:Definition: An attribute of relatedResource, relationship is a URI defining the type of relationship between the resource being described as the primary subject of the metadata card and the resource referenced by this element. Represents a relationship of some relationship type between the resource described by the parent irm:Resource element and another resource or resources.</p>
      <p xmlns="http://www.w3.org/1999/xhtml" ism:classification="U" ism:ownerProducer="USA" data-ded="ded:Obligation">ded:Obligation: (Conditional) Mandatory if relatedResource is present.</p>
      <p xmlns="http://www.w3.org/1999/xhtml" ism:classification="U" ism:ownerProducer="USA" data-ded="ded:Comment">ded:Comment: URIs representing relationships should be controlled by relationship type taxonomies that are registered.</p>
    </xsd:documentation>
  </xsd:annotation>
</xsd:attribute>
Schema location IC-IRM.xsd Copy and paste this link to your file browser, clicking the link MAY open in the browser. Opening in an XML aware editor is best.
Attribute irm:RelatedResourcesType / @irm:direction
Namespace urn:us:gov:ic:irm
Annotations
?

ded:Definition: An attribute of relatedResource used to indicate the direction of the relationship between the resource being described and the target related resource. Valid values are ?inbound,? ?outbound,? and ?bidirectional.?

ded:Obligation: (Optional)

ded:Comment: Inbound: Used to indicate that the relationship direction is from the related resource to the resource being described. Outbound: Used to indicate that the relationship direction is from the resource being described to the related resource identified. Outbound is the default value. Bidirectional: Used to indicate that the relationship is bidirectional between the resource being described and the related resource identified.

Type restriction of xsd:string
Properties
use optional
default outbound
Facets
enumeration inbound
?

Used to indicate that the relationship direction is from the related resource to the resource described in the instance IRM record.

enumeration outbound
?

Used to indicate that the relationship direction is from the resource described in the instance IRM record to the related resource identified.

enumeration bidirectional
?

Used to indicate that the relationship is bidirectional between the resource described in the instance IRM record and the related resource identified.

Used by
Source
<xsd:attribute name="direction" use="optional" default="outbound">
  <xsd:annotation>
    <xsd:documentation>&#x2028;
      <p xmlns="http://www.w3.org/1999/xhtml" ism:classification="U" ism:ownerProducer="USA" data-ded="ded:Definition">ded:Definition: An attribute of relatedResource used to indicate the direction of the relationship between the resource being described and the target related resource. Valid values are ?inbound,? ?outbound,? and ?bidirectional.?</p>
      <p xmlns="http://www.w3.org/1999/xhtml" ism:classification="U" ism:ownerProducer="USA" data-ded="ded:Obligation">ded:Obligation: (Optional)</p>
      <p xmlns="http://www.w3.org/1999/xhtml" ism:classification="U" ism:ownerProducer="USA" data-ded="ded:Comment">ded:Comment: Inbound: Used to indicate that the relationship direction is from the related resource to the resource being described. Outbound: Used to indicate that the relationship direction is from the resource being described to the related resource identified. Outbound is the default value. Bidirectional: Used to indicate that the relationship is bidirectional between the resource being described and the related resource identified.</p>
    </xsd:documentation>
  </xsd:annotation>
  <xsd:simpleType>
    <xsd:restriction base="xsd:string">
      <xsd:enumeration value="inbound">
        <xsd:annotation>
          <xsd:documentation>&#x2028;
            <p xmlns="http://www.w3.org/1999/xhtml" ism:ownerProducer="USA" ism:classification="U">Used to indicate that the relationship direction is from the related resource to the resource described in the instance IRM record.</p>
          </xsd:documentation>
        </xsd:annotation>
      </xsd:enumeration>
      <xsd:enumeration value="outbound">
        <xsd:annotation>
          <xsd:documentation>&#x2028;
            <p xmlns="http://www.w3.org/1999/xhtml" ism:ownerProducer="USA" ism:classification="U">Used to indicate that the relationship direction is from the resource described in the instance IRM record to the related resource identified.</p>
          </xsd:documentation>
        </xsd:annotation>
      </xsd:enumeration>
      <xsd:enumeration value="bidirectional">
        <xsd:annotation>
          <xsd:documentation>&#x2028;
            <p xmlns="http://www.w3.org/1999/xhtml" ism:ownerProducer="USA" ism:classification="U">Used to indicate that the relationship is bidirectional between the resource described in the instance IRM record and the related resource identified.</p>
          </xsd:documentation>
        </xsd:annotation>
      </xsd:enumeration>
    </xsd:restriction>
  </xsd:simpleType>
</xsd:attribute>
Schema location IC-IRM.xsd Copy and paste this link to your file browser, clicking the link MAY open in the browser. Opening in an XML aware editor is best.

This document has been approved for Public Release by the Office of the Director of National Intelligence. See Distribution Notice for details. Click Here