XML Schema Documentation

Table of Contents

top

Schema Document Properties

Target Namespace http://schemas.brainsellers.com/webservices/cms/2006-10
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.
Schema Composition
  • This schema imports schema(s) from the following namespace(s):
    • http://schemas.brainsellers.com/webservices/common/2006-10 (at common.xsd)
Documentation cmsサービス(コンテンツ管理サービス)で送受信するメッセージのXML仕様をXMLスキーマにて記述したものです。

サービスの各オペレーションと対応するXML要素の関係は次の図の通りとなります。

Declared Namespaces

Prefix Namespace
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
cms http://schemas.brainsellers.com/webservices/cms/2006-10
common http://schemas.brainsellers.com/webservices/common/2006-10
Schema Component Representation
<xs:schema elementFormDefault="qualified" targetNamespace="http://schemas.brainsellers.com/webservices/cms/2006-10">
<xs:import namespace="http://schemas.brainsellers.com/webservices/common/2006-10" schemaLocation="common.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: deleteRequest

Name deleteRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation コンテンツリポジトリ上の指定したファイルやディレクトリを削除します。

ディレクトリの場合、そのディレクトリ下に存在するファイルやディレクトリも削除されます。

本要素のコンテンツにて、ファイルやディレクトリの場所を指定します。

導入されたバージョン:
4.3.0
定義例: 

	<deleteRequest>/親ディレクトリ/削除したいファイルのファイル名</deleteRequest>
本要素の全子要素

XML Instance Representation
<cms:deleteRequest
id="xs:string [0..1]">
xs:string
</cms:deleteRequest>
Schema Component Representation
<xs:element name="deleteRequest">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="id" type="xs:string"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
top

Element: directory

Name directory
Type xs:NMTOKEN
Nillable no
Abstract no
Documentation ディレクトリを表します。

導入されたバージョン:
4.3.0
XML Instance Representation
<cms:directory> xs:NMTOKEN </cms:directory>
Schema Component Representation
<xs:element name="directory" type="xs:NMTOKEN"/>
top

Element: file

Name file
Type xs:NMTOKEN
Nillable no
Abstract no
Documentation ファイルを表します。

導入されたバージョン:
4.3.0
XML Instance Representation
<cms:file> xs:NMTOKEN </cms:file>
Schema Component Representation
<xs:element name="file" type="xs:NMTOKEN"/>
top

Element: from

Name from
Type xs:string
Nillable no
Abstract no
Documentation 変更前の値を設定します。

導入されたバージョン:
4.3.0
XML Instance Representation
<cms:from> xs:string </cms:from>
Schema Component Representation
<xs:element name="from" type="xs:string"/>
top

Element: getRequest

Name getRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation コンテンツリポジトリ上の指定したファイルを取得します。

本要素のコンテンツにて、ファイルの場所を指定します。

導入されたバージョン:
4.3.0
定義例: 

	<getRequest>/親ディレクトリ/取得したいファイルのファイル名</getRequest>
本要素の全子要素

XML Instance Representation
<cms:getRequest
id="xs:string [0..1]">
xs:string
</cms:getRequest>
Schema Component Representation
<xs:element name="getRequest">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="id" type="xs:string"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
top

Element: listRequest

Name listRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation コンテンツリポジトリ上の指定したディレクトリ内に存在するファイルやディレクトリの名前のリストを取得します。

本要素のコンテンツにて、ディレクトリの場所を指定します。

導入されたバージョン:
4.3.0
定義例: 

	<listRequest>/親ディレクトリ名/ディレクトリ名</listRequest>
本要素の全子要素

XML Instance Representation
<cms:listRequest
id="xs:string [0..1]">
xs:string
</cms:listRequest>
Schema Component Representation
<xs:element name="listRequest">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="id" type="xs:string"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
top

Element: listResponse

Name listResponse
Type Locally-defined complex type
Nillable no
Abstract no
Documentation ディレクトリとファイルのリストを表します。

導入されたバージョン:
4.3.0
定義例: 

	<listResponse>
		<file>1:ファイル名</file>
		<file>2:ファイル名</file>
		<file>3:ファイル名</file>
		<file>4:ファイル名</file>
		<directory>1:ディレクトリ名</directory>
		<directory>2:ディレクトリ名</directory>
		<directory>3:ディレクトリ名</directory>
	</listResponse>
本要素の全子要素

XML Instance Representation
<cms:listResponse>
<cms:file> ... </cms:file> [0..*]
<cms:directory> ... </cms:directory> [0..*]
</cms:listResponse>
Schema Component Representation
<xs:element name="listResponse">
<xs:complexType>
<xs:sequence>
<xs:element ref="cms:file" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="cms:directory" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: mkdirRequest

Name mkdirRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation コンテンツリポジトリ上の指定したディレクトリ内に新たにディレクトリを作成します。

本要素のコンテンツにて、作成するディレクトリの場所と名前を指定します。

導入されたバージョン:
4.3.0
定義例: 

	<mkdirRequest>/親ディレクトリ名/作成するディレクトリ名</mkdirRequest>
本要素の全子要素

XML Instance Representation
<cms:mkdirRequest
id="xs:string [0..1]">
xs:string
</cms:mkdirRequest>
Schema Component Representation
<xs:element name="mkdirRequest">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="id" type="xs:string"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
top

Element: moveRequest

Name moveRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation コンテンツリポジトリ上の指定したディレクトリに既存のファイルまたはディレクトリを移動します。

導入されたバージョン:
4.3.0
定義例: 

	<moveRequest>
		<from>/親ディレクトリ名/移動するファイル名</from>
		<to>/親ディレクトリ名/移動先のディレクトリ名</to>
	</moveRequest>
本要素の全子要素

XML Instance Representation
<cms:moveRequest>
<cms:from> ... </cms:from> [1]
<cms:to> ... </cms:to> [1]
</cms:moveRequest>
Schema Component Representation
<xs:element name="moveRequest">
<xs:complexType>
<xs:sequence>
<xs:element ref="cms:from"/>
<xs:element ref="cms:to"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: renameRequest

Name renameRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation コンテンツリポジトリ上の指定した既存のファイルまたはディレクトリの名前を変更します。

導入されたバージョン:
4.3.0
定義例: 

<renameRequest>
	<from>/親ディレクトリ名/旧ディレクトリ名</from>
	<to>新ディレクトリ名</to>
</renameRequest>
本要素の全子要素

XML Instance Representation
<cms:renameRequest>
<cms:from> ... </cms:from> [1]
<cms:to> ... </cms:to> [1]
</cms:renameRequest>
Schema Component Representation
<xs:element name="renameRequest">
<xs:complexType>
<xs:sequence>
<xs:element ref="cms:from"/>
<xs:element ref="cms:to"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: to

Name to
Type xs:string
Nillable no
Abstract no
Documentation 変更後の値を設定します。

導入されたバージョン:
4.3.0
XML Instance Representation
<cms:to> xs:string </cms:to>
Schema Component Representation
<xs:element name="to" type="xs:string"/>
top

Legend

Complex Type:

Schema Component Type

AusAddress

Schema Component Name
Super-types: Address < AusAddress (by extension)
Sub-types:
  • QLDAddress (by restriction)
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
Name AusAddress
Abstract no
The table above displays the properties of this schema component.
XML Instance Representation
<... country="Australia" >
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice [1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1] ?
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

Schema Component Representation
<complexType name="AusAddress">
<complexContent>
<extension base="Address">
<sequence>
<element name="state" type="AusStates"/>
<element name="postcode">
<simpleType>
<restriction base="string">
<pattern value="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attribute name="country" type="string" fixed="Australia"/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
top

Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top

Generated by xs3p.