User rest service

Base path: [ENVIRONMENT_URL]/rest/cpuservice

Send "Accept" HTTP header to specify content format. Possible values are "application/xml" for XML format, "application/json" for JSON format, and "text/plain" for text format (where permitted for simple string, boolean, and numeric responses).

Default response format is "application/xml".

Use BASIC authorization.

Description:Run the default user workflow.
Method:POST
Path:[ENVIRONMENT_URL]/cpuservice/runWorkflow
Parameters: Name Type Source Description
action String Form parameter action action
workflow String Form parameter workflow workflow
request ServiceRequest Deserialized from request body service request object
Returns:ServiceResponse
Sample:
            POST https://secure.cloudpiston.com/cpuservice/runWorkflow?action=myAction&workflow=myWorkflowName HTTP/1.1
            Accept: application/json

            {"payload":{"data":{"name1":"value1","name2":"value2"},"dataMaps":{"data1":{"name":"data1","entries":{"key2":"value2","key1":"value1"}},"data2":{"name":"data2","entries":{"key1":"value1"}}},"dataLists":{"list2":{"name":"name2","columns":["col1","col2"],"rows":[["c1r1","c2r1"],["c1r2","c2r2"],["c1r3","c2r3"],["c1r4","c2r4"]]},"list1":{"name":"myname","columns":["col1","col2"],"rows":[["c1r1","c2r1"],["c1r2","c2r2"],["c1r3","c2r3"],["c1r4","c2r4"]]}}}}
        
            POST https://secure.cloudpiston.com/cpuservice/runWorkflow?action=myAction&workflow=myWorkflowName HTTP/1.1
            Accept: application/xml

            <ns2:ServiceRequest xmlns:ns2="http://services.cloudpiston.com">
            <payload><data><entry><key>name</key><value>adsf</value></entry></data><dataMaps></dataMaps><dataLists></dataLists></payload><sizeLimit>10485760</sizeLimit><listLimit>500</listLimit><paging>true</paging><pageSize>100</pageSize><page>1</page><debug>true</debug></ns2:ServiceRequest>

        

 




    
    User rest service
    


   1  
   2  
   3  
   4  
   5  
   6  
   7  
   8  
   9  
  10  
  11  
  12  
  13  
  14  
  15  
  16  
  17  
  18  
  19  
  20  
  21  
  22  
  23  
  24  
  25  
  26  
  27  
  28  
  29  
  30  
  31  
  32  
  33  
  34  
  35  
  36  
  37  
  38  
  39  
  40  
  41  
  42  
  43  
  44  
  45  
  46  
  47  
  48  
  49  
  50  
  51  
  52  
  53  
  54  
  55  
  56  
  57  
  58  
  59  
  60  
  61  
  62  
  63  
  64  
  65  
  66  
  67  
  68  
  69  
  70  
  71  
  72  
  73  
  74  
  75  
  76  
  77  
  78  
  79  
  80  
  81  
  82  
  83  
  84  
  85  
  86  
  87  
  88  
  89  
  90  
  91  
  92  
  93  
  94  
  95  
  96  
  97  
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema version="1.0" targetNamespace="http://services.cloudpiston.com" xmlns:tns="http://services.cloudpiston.com" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:ns1="http://jaxb.dev.java.net/array">
  <xs:import namespace="http://jaxb.dev.java.net/array" schemaLocation="http://jaxb.dev.java.net/array"/>
  <xs:element name="Payload" type="tns:Payload"/>
  <xs:element name="ServiceRequest" type="tns:ServiceRequest"/>
  <xs:complexType name="ServiceRequest">
    <xs:sequence>
      <xs:element name="payload" type="tns:Payload" minOccurs="0"/>
      <xs:element name="sizeLimit" type="xs:int"/>
      <xs:element name="listLimit" type="xs:int"/>
      <xs:element name="paging" type="xs:boolean"/>
      <xs:element name="pageSize" type="xs:int"/>
      <xs:element name="page" type="xs:int"/>
      <xs:element name="debug" type="xs:boolean"/>
    </xs:sequence>
  </xs:complexType>
  <xs:complexType name="Payload">
    <xs:sequence>
      <xs:element name="data">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="entry" minOccurs="0" maxOccurs="unbounded">
              <xs:complexType>
                <xs:sequence>
                  <xs:element name="key" minOccurs="0" type="xs:string"/>
                  <xs:element name="value" minOccurs="0" type="xs:string"/>
                </xs:sequence>
              </xs:complexType>
            </xs:element>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
      <xs:element name="dataMaps">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="entry" minOccurs="0" maxOccurs="unbounded">
              <xs:complexType>
                <xs:sequence>
                  <xs:element name="key" minOccurs="0" type="xs:string"/>
                  <xs:element name="value" minOccurs="0" type="tns:Data"/>
                </xs:sequence>
              </xs:complexType>
            </xs:element>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
      <xs:element name="dataLists">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="entry" minOccurs="0" maxOccurs="unbounded">
              <xs:complexType>
                <xs:sequence>
                  <xs:element name="key" minOccurs="0" type="xs:string"/>
                  <xs:element name="value" minOccurs="0" type="tns:DataList"/>
                </xs:sequence>
              </xs:complexType>
            </xs:element>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
  <xs:complexType name="Data">
    <xs:sequence>
      <xs:element name="name" type="xs:string"/>
      <xs:element name="entries">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="entry" minOccurs="0" maxOccurs="unbounded">
              <xs:complexType>
                <xs:sequence>
                  <xs:element name="key" minOccurs="0" type="xs:string"/>
                  <xs:element name="value" minOccurs="0" type="xs:string"/>
                </xs:sequence>
              </xs:complexType>
            </xs:element>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
  <xs:complexType name="DataList">
    <xs:sequence>
      <xs:element name="name" type="xs:string" minOccurs="0"/>
      <xs:element name="columns" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="rows" type="ns1:stringArray" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>



    
    User rest service
    


   1  
   2  
   3  
   4  
   5  
   6  
   7  
   8  
   9  
  10  
  11  
  12  
  13  
  14  
  15  
  16  
  17  
  18  
  19  
  20  
  21  
  22  
  23  
  24  
  25  
  26  
  27  
  28  
  29  
  30  
  31  
  32  
  33  
  34  
  35  
  36  
  37  
  38  
  39  
  40  
  41  
  42  
  43  
  44  
  45  
  46  
  47  
  48  
  49  
  50  
  51  
  52  
  53  
  54  
  55  
  56  
  57  
  58  
  59  
  60  
  61  
  62  
  63  
  64  
  65  
  66  
  67  
  68  
  69  
  70  
  71  
  72  
  73  
  74  
  75  
  76  
  77  
  78  
  79  
  80  
  81  
  82  
  83  
  84  
  85  
  86  
  87  
  88  
  89  
  90  
  91  
  92  
  93  
  94  
  95  
  96  
  97  
  98  
  99  
 100  
 101  
 102  
 103  
 104  
 105  
 106  
 107  
 108  
 109  
 110  
 111  
 112  
 113  
 114  
 115  
 116  
 117  
 118  
 119  
 120  
 121  
 122  
 123  
 124  
 125  
 126  
 127  
 128  
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema version="1.0" targetNamespace="http://services.cloudpiston.com" xmlns:tns="http://services.cloudpiston.com" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:ns1="http://jaxb.dev.java.net/array">
  <xs:import namespace="http://jaxb.dev.java.net/array" schemaLocation="http://jaxb.dev.java.net/array"/>
  <xs:element name="Payload" type="tns:Payload"/>
  <xs:element name="ServiceResponse" type="tns:ServiceResponse"/>
  <xs:complexType name="ServiceResponse">
    <xs:sequence>
      <xs:element name="success" type="xs:boolean"/>
      <xs:element name="target" type="xs:string" minOccurs="0"/>
      <xs:element name="token" type="xs:string" minOccurs="0"/>
      <xs:element name="html" type="xs:string" minOccurs="0"/>
      <xs:element name="list" type="xs:string" minOccurs="0"/>
      <xs:element name="listIconColumn" type="xs:string" minOccurs="0"/>
      <xs:element name="errorMessage" type="xs:string" minOccurs="0"/>
      <xs:element name="successMessage" type="xs:string" minOccurs="0"/>
      <xs:element name="file" type="xs:string" minOccurs="0"/>
      <xs:element name="payload" type="tns:Payload" minOccurs="0"/>
      <xs:element name="currentPage" type="xs:int"/>
      <xs:element name="totalPages" type="xs:int"/>
      <xs:element name="action" type="xs:string" minOccurs="0"/>
      <xs:element name="data" type="xs:string" minOccurs="0"/>
      <xs:element name="listBindings">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="entry" minOccurs="0" maxOccurs="unbounded">
              <xs:complexType>
                <xs:sequence>
                  <xs:element name="key" minOccurs="0" type="xs:string"/>
                  <xs:element name="value" minOccurs="0" type="xs:string"/>
                </xs:sequence>
              </xs:complexType>
            </xs:element>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
      <xs:element name="debugInfo" type="tns:DebugInfo" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>
  <xs:complexType name="Payload">
    <xs:sequence>
      <xs:element name="data">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="entry" minOccurs="0" maxOccurs="unbounded">
              <xs:complexType>
                <xs:sequence>
                  <xs:element name="key" minOccurs="0" type="xs:string"/>
                  <xs:element name="value" minOccurs="0" type="xs:string"/>
                </xs:sequence>
              </xs:complexType>
            </xs:element>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
      <xs:element name="dataMaps">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="entry" minOccurs="0" maxOccurs="unbounded">
              <xs:complexType>
                <xs:sequence>
                  <xs:element name="key" minOccurs="0" type="xs:string"/>
                  <xs:element name="value" minOccurs="0" type="tns:Data"/>
                </xs:sequence>
              </xs:complexType>
            </xs:element>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
      <xs:element name="dataLists">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="entry" minOccurs="0" maxOccurs="unbounded">
              <xs:complexType>
                <xs:sequence>
                  <xs:element name="key" minOccurs="0" type="xs:string"/>
                  <xs:element name="value" minOccurs="0" type="tns:DataList"/>
                </xs:sequence>
              </xs:complexType>
            </xs:element>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
  <xs:complexType name="Data">
    <xs:sequence>
      <xs:element name="name" type="xs:string"/>
      <xs:element name="entries">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="entry" minOccurs="0" maxOccurs="unbounded">
              <xs:complexType>
                <xs:sequence>
                  <xs:element name="key" minOccurs="0" type="xs:string"/>
                  <xs:element name="value" minOccurs="0" type="xs:string"/>
                </xs:sequence>
              </xs:complexType>
            </xs:element>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
  <xs:complexType name="DataList">
    <xs:sequence>
      <xs:element name="name" type="xs:string" minOccurs="0"/>
      <xs:element name="columns" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="rows" type="ns1:stringArray" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>
  <xs:complexType name="DebugInfo">
    <xs:sequence>
      <xs:element name="workflow" type="xs:string" minOccurs="0"/>
      <xs:element name="line" type="xs:int"/>
      <xs:element name="action" type="xs:string" minOccurs="0"/>
      <xs:element name="callStack" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>