DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:struct:remote_api

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
plugin:struct:remote_api [2017-07-12 11:40] – [Methods] grosseplugin:struct:remote_api [2023-11-23 00:20] (current) – Reformatted Klap-in
Line 1: Line 1:
 +<= [[plugin:struct|Struct Plugin]]
 +
 ====== remote API ====== ====== remote API ======
 +
 The struct plugin exposes several methods that can be accessed via the [[devel:xmlrpc|XML-RPC API]]. You can find the current code in the [[https://github.com/cosmocode/dokuwiki-plugin-struct/blob/master/remote.php|remote.php]] The struct plugin exposes several methods that can be accessed via the [[devel:xmlrpc|XML-RPC API]]. You can find the current code in the [[https://github.com/cosmocode/dokuwiki-plugin-struct/blob/master/remote.php|remote.php]]
  
 +Note: The method names are prefixed with ''plugin.struct.'', for example ''plugin.struct.getSchema''
 ===== Methods ===== ===== Methods =====
   * **''getData()''** //Get the structured data of a given page//   * **''getData()''** //Get the structured data of a given page//
Line 22: Line 26:
     - parameter: **string** //string indicating the column to sort by//     - parameter: **string** //string indicating the column to sort by//
     * return **array** //array of rows, each row is an array of the column values//     * return **array** //array of rows, each row is an array of the column values//
 +
 +Postman example for getAggregationData(), as raw data:
 +
 +<code>
 +<?xml version="1.0"?>
 +<methodCall>
 +  <methodName>plugin.struct.getAggregationData</methodName>
 +  <params>
 +    <param>
 +      <value>
 +        <array>
 +          <data>
 +            <value>
 +              <string>myschema</string>
 +            </value>
 +          </data>
 +        </array>
 +        <array>
 +          <data>
 +            <value>
 +              <string>colour</string>
 +            </value>
 +          </data>
 +        </array>
 +        <array>
 +          <data>
 +            <value>
 +              <struct>
 +                <member>
 +                  <name>logic</name>
 +                  <value>
 +                    <string>and</string>
 +                  </value>
 +                </member>
 +                <member>
 +                  <name>condition</name>
 +                  <value>
 +                    <string>colour=red</string>
 +                  </value>
 +                </member>
 +              </struct>
 +            </value>
 +          </data>
 +        </array>
 +        <string>colour</string>
 +      </value>
 +    </param>
 +  </params>
 +</methodCall>
 +</code>
 +
plugin/struct/remote_api.1499852421.txt.gz · Last modified: 2017-07-12 11:40 by grosse

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki