Hc_restfs_domain_list

Команда предназначена для просмотра списка файлов по указанному пути на определенном домене.

Аналог команды в CoCon:

domain/<DOMAIN-NAME>/restfs/list

Метод HTTP-запроса:

POST

Шаблон HTTP-запроса:

http://host:port/commands/restfs_domain_list

Код HTTP-ответа:

200 – в случае успеха;
200 – в случае ошибки.

XSD-схема XML-запроса/ответа:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">

    <xs:include schemaLocation="error.xsd"/>

    <!-- in -->
    <xs:element name="in">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="request" minOccurs="1" maxOccurs="1">
                    <xs:complexType>
                        <xs:sequence>
                            <xs:element name="server" minOccurs="1" maxOccurs="unbounded">
                                <xs:complexType>
                                    <xs:attribute name="name" type="serverType" use="required"/>
                                    <xs:attribute name="path" type="xs:string" use="required"/>
                                </xs:complexType>
                            </xs:element>
                        </xs:sequence>
                        <xs:attribute name="domain" type="xs:string" use="required"/>
                    </xs:complexType>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="serverType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="fax"/>
            <xs:enumeration value="call"/>
            <xs:enumeration value="sounds"/>
            <xs:enumeration value="voicemail"/>
        </xs:restriction>
    </xs:simpleType>

    <xs:complexType name="clusterType">
        <xs:sequence>
            <xs:element name="file" minOccurs="0" maxOccurs="unbounded">
                <xs:complexType>
                    <xs:attribute name="type" type="xs:string" use="required"/>
                    <xs:attribute name="name" type="xs:string" use="required"/>
                    <xs:attribute name="size" type="xs:string" use="required"/>
                </xs:complexType>
            </xs:element>
        </xs:sequence>
        <xs:attribute name="name" type="xs:string" use="required"/>
    </xs:complexType>

    <!-- out -->
    <xs:element name="out">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="server" type="clusterType" minOccurs="0" maxOccurs="unbounded"/>
                <xs:element name="error" type="errorType" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

</xs:schema>

XML

Пример:

Запрос: http://192.168.1.21:9999/commands/restfs_domain_list

<in>
  <request domain="DOMAIN">
    <server name="cluster2" path=""/>
  </request>
</in>

XML

Ответ:

<?xml version="1.0"?>
<out
	xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_restfs_domain_list.xsd">
	<server name="call">
		<file type="directory" name="records" size="0"/>
		<file type="directory" name="subscribers" size="0"/>
		<file type="regular" name="cleaner.json" size="337"/>
	</server>
</out>

XML