Transactions rest service

Base path: [ENVIRONMENT_URL]/rest/transactions

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:Create a new transaction from the specified pal and returns the ID of the transaction..
Method:POST
Path:[ENVIRONMENT_URL]/cpservice/rest/transactions
Parameters: Name Type Source Description
palId String Form parameter palId Pal ID
Returns:String
Sample: 
POST https://secure.cloudpiston.com/cpservice/rest/transactions HTTP/1.1
        
palId=PAL-LL-118611E36AE-73EBCFA6

 

Description:Retrieves a list of transactions matching the search criteria.
Method:GET
Path:[ENVIRONMENT_URL]/cpservice/rest/transactions
Parameters: Name Type Source Description
search TransactionSearch Request headers:
category
description
exactCategory
exactDescription
exactName
includeTest
name
palId
sso
startRecord
status
systemStatus
webServiceStatus
 Optional TransactionSearch object (created from headers map
Returns:List of TransactionInfo
Sample: 
GET https://secure.cloudpiston.com/cpservice/rest/transactions HTTP/1.1
name: my pal
category: development
startRecord: 100

 

Description:Returns information on the given transaction including the action associated with the email link
Method:GET
Path:[ENVIRONMENT_URL]/cpservice/rest/transactions/getTransactionFromEmail
Parameters: Name Type Source Description
encryptedToken String Form parameter encryptedToken Encrypted Token for link
encryptedAction String Form parameter encryptedAction Encrypted Action for link
Returns:TransactionResult
Sample: 
GET https://secure.cloudpiston.com/cpservice/rest/transactions/getTransactionFromEmail HTTP/1.1

encryptedToken=5EC84E4FF8D151FBA0AF590F4E14420C310ADC3B190236B9592C5253D07D91D2&encryptedAction=5EC84E4FF8D151FBA0AF590F4E14420C310ADC3B190236B9592C5253D07D91D2

 

Description:Removes all roles for the given SSO for caller's enterprise
Method:POST
Path:[ENVIRONMENT_URL]/cpservice/rest/transactions/removeAllRoles
Parameters: Name Type Source Description
userSSO String Form parameter userSSO SSO for user
Returns:int
Sample: 
POST https://secure.cloudpiston.com/cpservice/rest/transactions/removeAllRoles HTTP/1.1

userSSO=SSO--11A4FD35049-30E75B79

 

Description:Retrieves TransactionInfo object details
Method:GET
Path:[ENVIRONMENT_URL]/cpservice/rest/transactions/*
Parameters: Name Type Source Description
id String Path element #1 Transaction ID
Returns:TransactionInfo
Sample: 
GET https://secure.cloudpiston.com/cpservice/rest/transactions/34FD8D6B-E935-B5AF-BCD1-19B98A605174:03E8:NX-TXP HTTP/1.1

 

Description:Creates a single use token for the specified transaction which is good for 60 seconds.
Method:POST
Path:[ENVIRONMENT_URL]/cpservice/rest/transactions/*/token
Parameters: Name Type Source Description
transactionId String Path element #1 Transaction ID
userSSO String Form parameter userSSO SSO for user
Returns:String
Sample: 
POST https://secure.cloudpiston.com/cpservice/rest/transactions/34FD8D6B-E935-B5AF-BCD1-19B98A605174:03E8:NX-TXP/token HTTP/1.1

userSSO=SSO--11A4FD35049-30E75B79

 

Description:Run the web service workflow from the transaction specified by transactionId
Method:POST
Path:[ENVIRONMENT_URL]/cpservice/rest/transactions/*/runWorkflow
Parameters: Name Type Source Description
transactionId String Path element #1 Transaction ID
content TransactionContent Deserialized from request body Transaction content
Returns:TransactionResult
Sample: 
POST https://secure.cloudpiston.com/cpservice/rest/transactions/34FD8D6B-E935-B5AF-BCD1-19B98A605174:03E8:NX-TXP/runWorkflow HTTP/1.1

<TransactionContent>
    <postData>
        <NameValue>
            <name>param1</name>
            <value>value1</value>
        </NameValue>
        <NameValue>
            <name>param2</name>
            <value>value2</value>
        </NameValue>
    </postData>
</TransactionContent>

 

Description:Run the web service workflow from the transaction specified by transactionId
Method:POST
Path:[ENVIRONMENT_URL]/cpservice/rest/transactions/*/run
Parameters: Name Type Source Description
transactionId String Path element #1 Transaction ID
content TransactionContent Deserialized from request body Transaction content
Returns:List of NameValue
Sample: 
POST https://secure.cloudpiston.com/cpservice/rest/transactions/34FD8D6B-E935-B5AF-BCD1-19B98A605174:03E8:NX-TXP/run HTTP/1.1

<TransactionContent>
    <postData>
        <NameValue>
            <name>param1</name>
            <value>value1</value>
        </NameValue>
        <NameValue>
            <name>param2</name>
            <value>value2</value>
        </NameValue>
    </postData>
</TransactionContent>

 

Description:Creates a single use token for anonymous access to the specified transaction which is good for 60 seconds.
Method:POST
Path:[ENVIRONMENT_URL]/cpservice/rest/transactions/*/anonymous
Parameters: Name Type Source Description
transactionId String Path element #1 Transaction ID
userSSO String Form parameter userSSO SSO for user
action String Form parameter action action to pass to workflow
Returns:String
Sample: 
POST https://secure.cloudpiston.com/cpservice/rest/transactions/34FD8D6B-E935-B5AF-BCD1-19B98A605174:03E8:NX-TXP/anonymous HTTP/1.1

userSSO=SSO--11A4FD35049-30E75B79&action=review-anonymous

 

Description:Removes all roles for the given SSO on the specified transaction
Method:POST
Path:[ENVIRONMENT_URL]/cpservice/rest/transactions/*/removeRole
Parameters: Name Type Source Description
transactionId String Path element #1 Transaction ID
userSSO String Form parameter userSSO SSO for user
Returns:int
Sample: 
POST https://secure.cloudpiston.com/cpservice/rest/transactions/34FD8D6B-E935-B5AF-BCD1-19B98A605174:03E8:NX-TXP/removeRole HTTP/1.1

userSSO=SSO--11A4FD35049-30E75B79

 




    
    Transactions rest service
    





   1  
   2  
   3  
   4  
   5  
   6  
   7  
   8  
   9  
  10  
  11  




<?xml version="1.0" encoding="UTF-8" standalone="yes"?>


<xs:schema version="1.0" targetNamespace="http://pal.contractpal.com" xmlns:xs="http://www.w3.org/2001/XMLSchema">




  <xs:complexType name="NameValue">


    <xs:sequence>


      <xs:element name="name" type="xs:string" minOccurs="0"/>


      <xs:element name="value" type="xs:string" minOccurs="0"/>


    </xs:sequence>


  </xs:complexType>


</xs:schema>













    
    Transactions 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  




<?xml version="1.0" encoding="UTF-8" standalone="yes"?>


<xs:schema version="1.0" targetNamespace="http://pal.contractpal.com" xmlns:tns="http://pal.contractpal.com" xmlns:xs="http://www.w3.org/2001/XMLSchema">




  <xs:element name="TransactionInfo" type="tns:TransactionInfo"/>




  <xs:complexType name="TransactionInfo">


    <xs:sequence>


      <xs:element name="id" type="xs:string" minOccurs="0"/>


      <xs:element name="name" type="xs:string" minOccurs="0"/>


      <xs:element name="description" type="xs:string" minOccurs="0"/>


      <xs:element name="category" type="xs:string" minOccurs="0"/>


      <xs:element name="status" type="xs:string" minOccurs="0"/>


      <xs:element name="systemStatus" type="xs:string" minOccurs="0"/>


      <xs:element name="webServiceStatus" type="xs:string" minOccurs="0"/>


      <xs:element name="createDate" type="xs:string" minOccurs="0"/>


      <xs:element name="executeEndDate" type="xs:string" minOccurs="0"/>


      <xs:element name="accessEndDate" type="xs:string" minOccurs="0"/>


      <xs:element name="archiveEndDate" type="xs:string" minOccurs="0"/>


      <xs:element name="modifiedDate" type="xs:string" minOccurs="0"/>


      <xs:element name="test" type="xs:boolean"/>


    </xs:sequence>


  </xs:complexType>


</xs:schema>













    
    Transactions 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  
 129  
 130  
 131  
 132  
 133  
 134  
 135  
 136  
 137  
 138  
 139  
 140  
 141  
 142  
 143  
 144  
 145  
 146  
 147  
 148  
 149  
 150  
 151  
 152  
 153  
 154  
 155  
 156  
 157  
 158  
 159  
 160  
 161  
 162  
 163  
 164  
 165  
 166  
 167  
 168  
 169  
 170  
 171  
 172  
 173  
 174  
 175  




<?xml version="1.0" encoding="UTF-8" standalone="yes"?>


<xs:schema elementFormDefault="qualified" version="1.0" targetNamespace="http://pal.contractpal.com" xmlns:tns="http://pal.contractpal.com" xmlns:xs="http://www.w3.org/2001/XMLSchema">




  <xs:element name="Document" type="tns:Document"/>




  <xs:element name="Image" type="tns:Image"/>




  <xs:element name="Style" type="tns:Style"/>




  <xs:element name="TransactionContent" type="tns:TransactionContent"/>




  <xs:complexType name="TransactionContent">


    <xs:sequence>


      <xs:element name="postData" form="unqualified" minOccurs="0">


        <xs:complexType>


          <xs:sequence>


            <xs:element name="NameValue" type="tns:NameValue" form="unqualified" minOccurs="0" maxOccurs="unbounded"/>


          </xs:sequence>


        </xs:complexType>


      </xs:element>


      <xs:element name="documents" form="unqualified" minOccurs="0">


        <xs:complexType>


          <xs:sequence>


            <xs:element name="Document" type="tns:Document" form="unqualified" minOccurs="0" maxOccurs="unbounded"/>


          </xs:sequence>


        </xs:complexType>


      </xs:element>


      <xs:element name="images" form="unqualified" minOccurs="0">


        <xs:complexType>


          <xs:sequence>


            <xs:element name="Image" type="tns:Image" form="unqualified" minOccurs="0" maxOccurs="unbounded"/>


          </xs:sequence>


        </xs:complexType>


      </xs:element>


      <xs:element name="styles" form="unqualified" minOccurs="0">


        <xs:complexType>


          <xs:sequence>


            <xs:element name="Style" type="tns:Style" form="unqualified" minOccurs="0" maxOccurs="unbounded"/>


          </xs:sequence>


        </xs:complexType>


      </xs:element>


      <xs:element name="payload" type="xs:base64Binary" form="unqualified" minOccurs="0"/>


    </xs:sequence>


  </xs:complexType>




  <xs:complexType name="NameValue">


    <xs:sequence>


      <xs:element name="name" type="xs:string" form="unqualified" minOccurs="0"/>


      <xs:element name="value" type="xs:string" form="unqualified" minOccurs="0"/>


    </xs:sequence>


  </xs:complexType>




  <xs:complexType name="Document">


    <xs:complexContent>


      <xs:extension base="tns:PalFile">


        <xs:sequence>


          <xs:element name="description" type="xs:string" minOccurs="0"/>


          <xs:element name="font" type="xs:string" minOccurs="0"/>


          <xs:element name="fields" minOccurs="0">


            <xs:complexType>


              <xs:sequence>


                <xs:element name="Field" type="tns:Field" minOccurs="0" maxOccurs="unbounded"/>


              </xs:sequence>


            </xs:complexType>


          </xs:element>


          <xs:element name="signatures" minOccurs="0">


            <xs:complexType>


              <xs:sequence>


                <xs:element name="Signature" type="tns:Signature" minOccurs="0" maxOccurs="unbounded"/>


              </xs:sequence>


            </xs:complexType>


          </xs:element>


        </xs:sequence>


      </xs:extension>


    </xs:complexContent>


  </xs:complexType>




  <xs:complexType name="PalFile" abstract="true">


    <xs:sequence>


      <xs:element name="content" type="xs:base64Binary" minOccurs="0"/>


      <xs:element name="contentType" type="xs:string" minOccurs="0"/>


      <xs:element name="filename" type="xs:string" minOccurs="0"/>


      <xs:element name="palType" type="xs:string" minOccurs="0"/>


      <xs:element name="digest" type="xs:base64Binary" minOccurs="0"/>


      <xs:element name="bookmarks" minOccurs="0">


        <xs:complexType>


          <xs:sequence>


            <xs:element name="Bookmark" type="tns:Bookmark" minOccurs="0" maxOccurs="unbounded"/>


          </xs:sequence>


        </xs:complexType>


      </xs:element>


    </xs:sequence>


  </xs:complexType>




  <xs:complexType name="Field">


    <xs:sequence>


      <xs:element name="id" type="xs:string" minOccurs="0"/>


      <xs:element name="value" type="xs:string" minOccurs="0"/>


      <xs:element name="roles" type="xs:string" minOccurs="0"/>


      <xs:element name="picklist" type="xs:string" minOccurs="0"/>


      <xs:element name="type" type="tns:fieldType" minOccurs="0"/>


      <xs:element name="font" type="xs:string" minOccurs="0"/>


      <xs:element name="x" type="xs:int"/>


      <xs:element name="y" type="xs:int"/>


      <xs:element name="width" type="xs:int"/>


      <xs:element name="height" type="xs:int"/>


      <xs:element name="page" type="xs:int"/>


      <xs:element name="palDefined" type="xs:boolean"/>


      <xs:element name="clazz" type="xs:string" minOccurs="0"/>


      <xs:element name="style" type="xs:string" minOccurs="0"/>


    </xs:sequence>


  </xs:complexType>




  <xs:complexType name="Signature">


    <xs:sequence>


      <xs:element name="id" type="xs:string" minOccurs="0"/>


      <xs:element name="type" type="xs:string" minOccurs="0"/>


      <xs:element name="target" type="xs:string" minOccurs="0"/>


      <xs:element name="role" type="xs:string" minOccurs="0"/>


      <xs:element name="groupId" type="xs:string" minOccurs="0"/>


      <xs:element name="reference" type="xs:string" minOccurs="0"/>


      <xs:element name="required" type="xs:boolean"/>


      <xs:element name="recordTime" type="xs:int"/>


      <xs:element name="page" type="xs:int"/>


      <xs:element name="x" type="xs:int"/>


      <xs:element name="y" type="xs:int"/>


      <xs:element name="customWidth" type="xs:int"/>


      <xs:element name="customHeight" type="xs:int"/>


    </xs:sequence>


  </xs:complexType>




  <xs:complexType name="Bookmark">


    <xs:sequence>


      <xs:element name="line" type="xs:int"/>


      <xs:element name="text" type="xs:string" minOccurs="0"/>


      <xs:element name="type" type="tns:type" minOccurs="0"/>


      <xs:element name="mnemonic" type="xs:unsignedShort"/>


    </xs:sequence>


  </xs:complexType>




  <xs:complexType name="Image">


    <xs:complexContent>


      <xs:extension base="tns:PalFile">


        <xs:sequence/>


      </xs:extension>


    </xs:complexContent>


  </xs:complexType>




  <xs:complexType name="Style">


    <xs:complexContent>


      <xs:extension base="tns:PalFile">


        <xs:sequence/>


      </xs:extension>


    </xs:complexContent>


  </xs:complexType>




  <xs:simpleType name="fieldType">


    <xs:restriction base="xs:string">


      <xs:enumeration value="TEXT"/>


      <xs:enumeration value="TEXTAREA"/>


      <xs:enumeration value="CHECKBOX"/>


      <xs:enumeration value="RADIO"/>


      <xs:enumeration value="SELECT"/>


      <xs:enumeration value="CHECKBOXCHECKED"/>


    </xs:restriction>


  </xs:simpleType>




  <xs:simpleType name="type">


    <xs:restriction base="xs:string">


      <xs:enumeration value="TODO"/>


      <xs:enumeration value="BOOKMARK"/>


    </xs:restriction>


  </xs:simpleType>


</xs:schema>













    
    Transactions 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  




<?xml version="1.0" encoding="UTF-8" standalone="yes"?>


<xs:schema version="1.0" targetNamespace="http://pal.contractpal.com" xmlns:tns="http://pal.contractpal.com" xmlns:xs="http://www.w3.org/2001/XMLSchema">




  <xs:element name="Result" type="tns:Result"/>




  <xs:element name="TransactionInfo" type="tns:TransactionInfo"/>




  <xs:element name="TransactionResult" type="tns:TransactionResult"/>




  <xs:complexType name="TransactionResult">


    <xs:complexContent>


      <xs:extension base="tns:Result">


        <xs:sequence>


          <xs:element name="transactionId" type="xs:string" minOccurs="0"/>


          <xs:element name="transactionInfoList" minOccurs="0">


            <xs:complexType>


              <xs:sequence>


                <xs:element name="TransactionInfo" type="tns:TransactionInfo" minOccurs="0" maxOccurs="unbounded"/>


              </xs:sequence>


            </xs:complexType>


          </xs:element>


          <xs:element name="token" type="xs:string" minOccurs="0"/>


          <xs:element name="action" type="xs:string" minOccurs="0"/>


          <xs:element name="palId" type="xs:string" minOccurs="0"/>


          <xs:element name="emailType" type="xs:string" minOccurs="0"/>


          <xs:element name="recordsProcessed" type="xs:int"/>


        </xs:sequence>


      </xs:extension>


    </xs:complexContent>


  </xs:complexType>




  <xs:complexType name="Result">


    <xs:sequence>


      <xs:element name="success" type="xs:boolean"/>


      <xs:element name="messages" minOccurs="0">


        <xs:complexType>


          <xs:sequence>


            <xs:element name="Message" type="tns:Message" minOccurs="0" maxOccurs="unbounded"/>


          </xs:sequence>


        </xs:complexType>


      </xs:element>


      <xs:element name="data" minOccurs="0">


        <xs:complexType>


          <xs:sequence>


            <xs:element name="NameValue" type="tns:NameValue" minOccurs="0" maxOccurs="unbounded"/>


          </xs:sequence>


        </xs:complexType>


      </xs:element>


      <xs:element name="payload" type="tns:Payload" minOccurs="0"/>


    </xs:sequence>


  </xs:complexType>




  <xs:complexType name="TransactionInfo">


    <xs:sequence>


      <xs:element name="id" type="xs:string" minOccurs="0"/>


      <xs:element name="name" type="xs:string" minOccurs="0"/>


      <xs:element name="description" type="xs:string" minOccurs="0"/>


      <xs:element name="category" type="xs:string" minOccurs="0"/>


      <xs:element name="status" type="xs:string" minOccurs="0"/>


      <xs:element name="systemStatus" type="xs:string" minOccurs="0"/>


      <xs:element name="webServiceStatus" type="xs:string" minOccurs="0"/>


      <xs:element name="createDate" type="xs:string" minOccurs="0"/>


      <xs:element name="executeEndDate" type="xs:string" minOccurs="0"/>


      <xs:element name="accessEndDate" type="xs:string" minOccurs="0"/>


      <xs:element name="archiveEndDate" type="xs:string" minOccurs="0"/>


      <xs:element name="modifiedDate" type="xs:string" minOccurs="0"/>


      <xs:element name="test" type="xs:boolean"/>


    </xs:sequence>


  </xs:complexType>




  <xs:complexType name="Message">


    <xs:sequence>


      <xs:element name="message" type="xs:string"/>


      <xs:element name="type" type="xs:string" nillable="true" minOccurs="0"/>


    </xs:sequence>


  </xs:complexType>




  <xs:complexType name="NameValue">


    <xs:sequence>


      <xs:element name="name" type="xs:string" minOccurs="0"/>


      <xs:element name="value" type="xs:string" minOccurs="0"/>


    </xs:sequence>


  </xs:complexType>




  <xs:complexType name="Payload">


    <xs:sequence>


      <xs:element name="filename" type="xs:string" minOccurs="0"/>


      <xs:element name="contentType" type="xs:string" minOccurs="0"/>


      <xs:element name="content" type="xs:base64Binary" minOccurs="0"/>


    </xs:sequence>


  </xs:complexType>


</xs:schema>













    
    Transactions 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  




<?xml version="1.0" encoding="UTF-8" standalone="yes"?>


<xs:schema version="1.0" targetNamespace="http://pal.contractpal.com" xmlns:tns="http://pal.contractpal.com" xmlns:xs="http://www.w3.org/2001/XMLSchema">




  <xs:element name="TransactionSearch" type="tns:TransactionSearch"/>




  <xs:complexType name="TransactionSearch">


    <xs:sequence>


      <xs:element name="name" type="xs:string" minOccurs="0"/>


      <xs:element name="description" type="xs:string" minOccurs="0"/>


      <xs:element name="category" type="xs:string" minOccurs="0"/>


      <xs:element name="status" type="xs:string" minOccurs="0"/>


      <xs:element name="systemStatus" type="xs:string" minOccurs="0"/>


      <xs:element name="webServiceStatus" type="xs:string" minOccurs="0"/>


      <xs:element name="exactName" type="xs:boolean"/>


      <xs:element name="exactDescription" type="xs:boolean"/>


      <xs:element name="exactCategory" type="xs:boolean"/>


      <xs:element name="startRecord" type="xs:int"/>


      <xs:element name="includeTest" type="xs:boolean"/>


      <xs:element name="palId" type="xs:string" minOccurs="0"/>


      <xs:element name="sso" type="xs:string" minOccurs="0"/>


    </xs:sequence>


  </xs:complexType>


</xs:schema>