EntityAPIService

EntityAPIService enables the deployment and management of Web based data services provided by Pervasive DataCloud. The methods exposed by this SOAP based WebService API allows CRUD operations on DataCloud Entities like Product/Integration, Provisioning/RuntimeConfiguration, etc. This document lists all these methods with their right usage. Also sample SOAP Request and Response along with Java sample code snippets are provided for each method.

Please refer to the following document for a sample Java Application on how to consume this SOAP API
http://cloud.pervasive.com/Technical/CloudUsersGuide/ConsumingtheSOAPAPISampleApplication.aspx

Refer to this document for a general overview on DataCloud Entities
http://cloud.pervasive.com/Technical/CloudUsersGuide/PervasiveDataCloud2APIDocumentation.aspx

 

createProduct

Create a custom product associated with the current user.

Parameters

Name Type Description
product
Product
the product to create
sessionId
String
the sessionId of the current user session

Returns

Name Type Description
Product
Product
the newly persisted product

Errors

Name
InvalidSessionException
CloudAPIException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:createProduct>
<!--Optional:-->
<product permissions="?" id="43546">
<!--Optional:-->
<owner id="171">shuckertestuser</owner>
<!--Optional:-->
<account>100</account>
<!--Optional:-->
<active>true</active>
<!--Optional:-->
<concurrent>true</concurrent>
<!--Optional:-->
<createdby>171</createdby>
<!--Optional:-->
<createddate>2011-11-02T00:00:00-04:00</createddate>
<!--Optional:-->
<deleted>false</deleted>
<!--Optional:-->
<description>datacloud Documentqation</description>
<!--Optional:-->
<destination>355</destination>
<!--Optional:-->
<group>145</group>
<!--Optional:-->
<integrationspec>Tiara</integrationspec>
<!--Optional:-->
<lastmodifiedby>171</lastmodifiedby>
<!--Optional:-->
<lastmodifieddate>2011-11-01T00:00:00-04:00</lastmodifieddate>
<!--Optional:-->
<name>Product1</name>
<!--Optional:-->
<parameters>
<!--Zero or more repetitions:-->
<parameter key="myProductKey" secure="no">myProductValue</parameter>
</parameters>
<!--Optional:-->
<parentProvisioningId>15046</parentProvisioningId>
<!--Optional:-->
<process>defaultProcess.ip.xml</process>
<!--Optional:-->
<startdate>2011-10-24T00:00:00-04:00</startdate>
<!--Optional:-->
<userProduct>true</userProduct>
</product>
<!--Optional:-->
<sessionId>82f379ab-44e4-4d04-b0da-7c11404cfd99</sessionId>
</crud:createProduct>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:createProductResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return id="43546" permissions="">
<owner id="171">shuckertestuser</owner>
<account>1</account>
<active>true</active>
<concurrent>true</concurrent>
<createdby>171</createdby>
<deleted>false</deleted>
<description>datacloud Documentqation</description>
<destination>355</destination>
<group>145</group>
<integrationspec>Tiara</integrationspec>
<lastmodifiedby>171</lastmodifiedby>
<name>Product1</name>
<parameters>
<parameter key="myProductKey">myProductValue</parameter>
</parameters>
<parentProvisioningId>15046</parentProvisioningId>
<process>defaultProcess.ip.xml</process>
<userProduct>true</userProduct>
</return>
</ns2:createProductResponse>
</S:Body>
</S:Envelope>

 

 
Java Code Sample

Method Signature:  public com.pervasive.datasolutions.datacloud.persistence.ent.Product createProduct                                                                         (com.pervasive.datasolutions.datacloud.persistence.ent.Product product, 
                                                                                                                                    String sessionId)
                                                throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                                com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:              

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Product p=new Product();

p.setActive(true);
p.setConcurrent(true);

User u=new User();
p.setCreatedby(u);
p.setCreateddate((long) (2010-05-14));
p.setDeleted(true);
p.setGroup(2);
p.setDescription("Integration Product");
p.setDestination((long) 73);

p.setGroup(2);
p.setId("0d2c6593-9482-483b-a913-9cef2be60d100");
p.setIntegrationspec("integrationspec");
p.setLastmodifiedby(u);
p.setLastmodifieddate((long) (2010-05-14));
p.setName("testproduct");

UserInfo uf=new UserInfo();
uf.setId(172);
uf.set_value("testuser");

p.setOwner(uf);

ProductParameter[] pparameter=new ProductParameter[5];
pparameter[0].setKey("productKey");
pparameter[0].set_value("productKeyValue");
pparameter[0].setSecure(true);

p.setParameters(pparameter);
p.setParentProvisioningId((long) 13351);
p.setPermissions("READ");
p.setProcess("integrationSpec/p_WrapperProcess.ip.xml");

p.setStartdate((long) (2010-05-14));
p.setUserProduct(true);

Product product = stub.createProduct(p, "125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7");

 

findProduct

Return a product by id.

Parameters

Name Type Description
sku
String
the id of the product to return
sessionId
String
sessionId of the current session

Returns

Name Type Description
Product
Product
the products

Errors

Name
InvalidSessionException
CloudAPIException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:findProduct>
<!--Optional:-->
<sku>0d2c6593-9482-483b-a913-9cef2be60d55</sku>
<!--Optional:-->
<sessionId>125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130</sessionId>
</crud:findProduct>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findProductResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return id="0d2c6593-9482-483b-a913-9cef2be60d55">
<owner id="171">shuckertestuser</owner>
<active>true</active>
<concurrent>false</concurrent>
<description>big test product</description>
<destination>74</destination>
<name>Big Test Product</name>
<parameters/>
<parentProvisioningId>13351</parentProvisioningId>
<process>integrationSpec/p_WrapperProcess.ip.xml</process>
<userProduct>true</userProduct>
</return>
</ns2:findProductResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:            public com.pervasive.datasolutions.datacloud.persistence.ent.Product findProduct                                                                                                    (java.lang.String sku, java.lang.String sessionId)                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException                                                                                                                           

Usage:                

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Product p = stub.findProduct("6ebacc70-12ef-45d4-b18a-c6834a7dac49", "125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7");

 

editProduct

Edit a custom Product object associated with the user.

Parameters

Name Type Description
product
Product
the new value of the Product
sessionId
String
sessionId of the current session

Errors

Name
InvalidSessionException
CloudAPIException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:editProduct>
<!--Optional:-->
<product permissions="?" id="43546">
<!--Optional:-->
<owner id="171">shuckertestuser</owner>
<!--Optional:-->
<account>100</account>
<!--Optional:-->
<active>true</active>
<!--Optional:-->
<concurrent>true</concurrent>
<!--Optional:-->
<createdby>171</createdby>
<!--Optional:-->
<createddate>2011-11-02T00:00:00-04:00</createddate>
<!--Optional:-->
<deleted>false</deleted>
<!--Optional:-->
<description>Updated Product</description>
<!--Optional:-->
<destination>355</destination>
<!--Optional:-->
<group>145</group>
<!--Optional:-->
<integrationspec>Pervasive</integrationspec>
<!--Optional:-->
<lastmodifiedby>171</lastmodifiedby>
<!--Optional:-->
<lastmodifieddate>2011-11-01T00:00:00-04:00</lastmodifieddate>
<!--Optional:-->
<name>NewProduct</name>
<!--Optional:-->
<parameters>
<!--Zero or more repetitions:-->
<parameter key="myProductKey1" secure="no">myProductValue1</parameter>
</parameters>
<!--Optional:-->
<parentProvisioningId>15046</parentProvisioningId>
<!--Optional:-->
<process>defaultProcess.ip.xml</process>
<!--Optional:-->
<startdate>2011-10-24T00:00:00-04:00</startdate>
<!--Optional:-->
<userProduct>true</userProduct>
</product>
<!--Optional:-->
<sessionId>82f379ab-44e4-4d04-b0da-7c11404cfd99</sessionId>
</crud:editProduct>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:editProductResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity"/>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:            public void editProduct                                                           (com.pervasive.datasolutions.datacloud.persistence.ent.Product product,
                                                                                                                                                     String sessionId)
                                            throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,                                             com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:      

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Product p=new Product();

p.setActive(true);
p.setConcurrent(true);
User u=new User();
p.setCreatedby(u);
p.setCreateddate((long) (2010-05-14));
p.setDeleted(true);
p.setDescription("Integration Product");
p.setDestination((long) 73);
p.setGroup(2);
p.setId("0d2c6593-9482-483b-a913-9cef2be60d100");
p.setIntegrationspec("integrationspec");
p.setLastmodifiedby(u);
p.setLastmodifieddate((long) (2010-05-14));
p.setName("testproduct");

UserInfo uf=new UserInfo();
uf.setId(172);
uf.set_value("testuser");
p.setOwner(uf);

ProductParameter[] pparameter=new ProductParameter[5];
pparameter[0].setKey("productKey");
pparameter[0].set_value("productKeyValue");
pparameter[0].setSecure(true);

p.setParameters(pparameter);
p.setParentProvisioningId((long) 13351);
p.setPermissions("READ");
p.setProcess("integrationSpec/p_WrapperProcess.ip.xml");

p.setStartdate((long) (2010-05-14));
p.setUserProduct(true);

stub.editProduct(p, "125003101227.4253.DC58.5A73.4AC1.AED2.5687");

 

listProducts

Lists the products associated with the current user, including products not controlled by the user, but for which the user owns provisionings.

Parameters

Name Type Description
firstResult
Integer
0-indexed ordinal of the first record to return
maxResults
Integer
the maximum number of records to return
sessionId
String
sessionId of the current session

Returns

Name Type Description
Product (0..*)
List<Product>
a list of products

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:listProducts>
<!--Optional:-->
<firstResult>0</firstResult>
<!--Optional:-->
<maxResults>100</maxResults>
<!--Optional:-->
<sessionId>125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130</sessionId>
</crud:listProducts>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:listProductsResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return id="0d2c6593-9482-483b-a913-9cef2be60d55">
<owner id="171">shuckertestuser</owner>
<active>true</active>
<concurrent>false</concurrent>
<description>big test product</description>
<destination>74</destination>
<name>Big Test Product</name>
<parameters/>
<parentProvisioningId>13351</parentProvisioningId>
<process>integrationSpec/p_WrapperProcess.ip.xml</process>
<userProduct>true</userProduct>
</return>
<return id="IDSSLEU-E01W201-91900-01">
<owner id="335">dsadmin</owner>
<active>true</active>
<concurrent>false</concurrent>
<description>Finds duplicates in Salesforce.com</description>
<destination>71</destination>
<name>Sleuth</name>
<parameters>
<parameter key="salesforce.com.username"/>
<parameter key="salesforce.com.password"/>
</parameters>
<process>sleuth.djar</process>
<userProduct>false</userProduct>
</return>       
      .
      .
      .
<ns2:listProductsResponse>
</S:Body>
</S:Envelope>  

 

Java Code Sample

Method Signature:   public java.util.List
<com.pervasive.datasolutions.datacloud.persistence.ent.Product> listProducts(java.lang.Integer firstResults,
                                                                                       java.lang.Integer maxResult, java.lang.String sessionId )
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,

                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:      

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

import java.util.List;
EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

List<Product> prod = stub.listProducts(0, 100, "125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7");

 

listProductsByGroup

List the products associated with the group

Parameters

Name Type Description
firstResult
Integer
0-indexed ordinal of the first record to return
maxResults
Integer
the maximum number of records to return
id
Long
the group id
sessionId
String
sessionId of the current session

Returns

Name Type Description
Product (0..*)
List<Product>
a list of products

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:listProductsByGroup>
<!--Optional:-->
<firstResult>0</firstResult>
<!--Optional:-->
<maxResults>1</maxResults>
<!--Optional:-->
<id>2</id>
<!--Optional:-->
<sessionId>560ee69a-c0cd-4f11-9579-4cda37be4220</sessionId>
</crud:listProductsByGroup>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:listProductsByGroupResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return id="NewProductSku-1318439727860" permissions="">
<owner id="171">shuckertestuser</owner>
<account>1</account>
<active>true</active>
<concurrent>true</concurrent>
<createdby>171</createdby>
<deleted>false</deleted>
<description>Edited successfully</description>
<destination>355</destination>
<group>2</group>
<integrationspec>Tiara</integrationspec>
<lastmodifiedby>171</lastmodifiedby>
<name>ProductSKU8</name>
<parameters>
<parameter key="myProductKey8">myProductValue8</parameter>
</parameters>
<parentProvisioningId>15046</parentProvisioningId>
<process>defaultProcess.ip.xml</process>
<userProduct>true</userProduct>
</return>
</ns2:listProductsByGroupResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:  List <com.pervasive.datasolutions.datacloud.persistence.ent.Product> listProductsByGroup                                                                             (Integer firstResults, Integer maxResult, Long id, String sessionId )
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,

                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:      

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import java.util.List;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

List<Product> prod = stub.listProductsByGroup(0, 10,2, "34f1befe-a322-411f-aa68-e8f10c22c750");

 

deleteProduct

Delete a custom product by id.

Parameters

Name   Description
sku
String
id of the product to delete
sessionId
String
sessionId of the current session

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:deleteProduct>
<!--Optional:-->
<sku>0d2c6593-9482-483b-a913-9cef2be60d100</sku>
<!--Optional:-->
<sessionId>125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7</sessionId>
</crud:deleteProduct>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:deleteProductResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity"/>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:          public void deleteProduct(java.lang.String sku, java.lang.String sessionId)
                                                 throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                                 com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:      

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

stub.deleteProduct("0d2c6593-9482-483b-a913-9cef2be60d100", "125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7");

 

getProductCount

Count the Products associated with the current User, including Products which the user does not own, but for which the User has provisionings.

Parameters

Name Type Description
sessionId
String
sessionId of the current session

Returns

Name Type Description
Product count
Long
count of products

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:getProductCount>
<!--Optional:-->
<sessionId>125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130</sessionId>
</crud:getProductCount>
</soapenv:Body>
</soapenv:Envelope>  

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getProductCountResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>14</return>
</ns2:getProductCountResponse>
</S:Body>
</S:Envelope>  

 

Java Code Sample

Method Signature:         public java.lang.Long getProductCount(java.lang.String sessionId)
                                                 throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,                                                  com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:                 

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Long Count=stub.getProductCount("125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130");

 

getProductParameter

Return the value of a parameter associated with a product referenced by id.

Parameters

Name Type Description
sku
String
the id of the product
key
String
the key of the parameter to return
sessionId
String
sessionId of the current session

Returns

Name Type Description
Parameter Value
String
the value of the parameter

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:getProductParameter>
<!--Optional:-->
<sku>0d2c6593-9482-483b-a913-9cef2be60d55</sku>
<!--Optional:-->
<key>parameterkey</key>
<!--Optional:-->
<sessionId>125003101223.6634.326B.C412.41CD.8643.4190</sessionId>
</crud:getProductParameter>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getProductParameterResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud"
 xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
 <return>parametervalue</return>
 </ns2:getProductParameterResponse>
 </S:Body>
 </S:Envelope>

 

Java Code Sample

Method Signature:        public java.lang.String getProductParameter (java.lang.String sku,
                                                                                                                  java.lang.String key,
                                                                                                                  java.lang.String sessionId)
                                             throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                             com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:      

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

String ProductParameter=stub.getProductParameter("0d2c6593-9482-483b-a913-9cef2be60d55", "parameterkey", "125003101223.6634.326B.C412.41CD.8643.4190");

 

putProductParameter

Store a key/value pair associated with a Product identified by id.

Parameters

Name Type Description
sku
String
the id of the Product
key
String
the key of the parameter
value
String
the value of the parameter
sessionId
String
sessionId of the current session

Returns

Name Type Description
Parameter Value
String
the old value of the parameter, or null if it is a new parameter

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:putProductParameter>
<!--Optional:-->
<sku>0d2c6593-9482-483b-a913-9cef2be60d55</sku>
<!--Optional:-->
<key>parameterkey</key>
<!--Optional:-->
<value>parametervalue</value>
<!--Optional:-->
<sessionId>125003101223.6634.326B.C412.41CD.8643.4190</sessionId>
</crud:putProductParameter>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:putProductParameterResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity"/>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:               public java.lang.String putProductParameter (java.lang.String sku,
                                                                                                                          java.lang.String key,
                                                                                                                          java.lang.String value,
                                                                                                                          java.lang.String sessionId)
                                        throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                        com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:                  

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

String ProductParameter=stub.putProductParameter("0d2c6593-9482-483b-a913-9cef2be60d55", "parameterkey", "parametervalue", "125003101223.6634.326B.C412.41CD.8643.4190");

 

removeProductParameter

Remove a parameter from a Product.

Parameters

Name Type Description
sku
String
the id of the Product from which to remove a parameter
key
String
the key of the parameter
sessionId
String
sessionId of the current session

Returns

Name Type Description
Parameter Value
String
the old value of the parameter

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:removeProductParameter>
<!--Optional:-->
<sku>0d2c6593-9482-483b-a913-9cef2be60d55</sku>
<!--Optional:-->
<key>parameterkey</key>
<!--Optional:-->
<sessionId>125003101223.6634.326B.C412.41CD.8643.4190</sessionId>
</crud:removeProductParameter>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:removeProductParameterResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>parametervalue</return>
</ns2:removeProductParameterResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:        public java.lang.String removeProductParameter(java.lang.String sku,
                                                                                                                        java.lang.String key,
                                                                                                                       java.lang.String sessionId)
                                           throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                           com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:                

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

String ParameterValue=stub.removeProductParameter("0d2c6593-9482-483b-a913-9cef2be60d55", "parameterkey", "125003101223.6634.326B.C412.41CD.8643.4190");

 

listProductFiles

List files associated with a Product.

Parameters

Name Type Description
id
String
SKU of the Product
sessionId
String
sessionId of the current session

Returns

Name Type Description
File Names
List <java.lang.String>
list of filenames associated with the Product

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:listProductFiles>
<!--Optional:-->
<productId>0d2c6593-9482-483b-a913-9cef2be60d55</productId>
<!--Optional:-->
<sessionId>125003101223.6634.326B.C412.41CD.8643.4190</sessionId>
</crud:listProductFiles>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:listProductFilesResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>integrationSpec/p_WrapperProcess.ip.xml</return>
<return>integrationSpec/test.ip.xml.txt</return>
</ns2:listProductFilesResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:           public java.util.List<java.lang.String> listProductFiles(java.lang.String id,
                                                                                                                          java.lang.String sessionId)
                                          throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                         com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:              

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import java.util.List;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

List<String> productfiles = stub.listProductFiles("0d2c6593-9482-483b-a913-9cef2be60d55", "125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7");

 

getProductFile

Download a file associated with a Product.

Parameters

Name Type Description
id
String
SKU of the Product
filename
String
name of the file to download
sessionId
String
sessionId of the current session

Returns

Name Type Description
Product File
DataHandler
DataHandler wrapping the file data

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:getProductFile>
<!--Optional:-->
<productId>0d2c6593-9482-483b-a913-9cef2be60d55</productId>
<!--Optional:-->
<filename>integrationSpec/p_WrapperProcess.ip.xml</filename>
<!--Optional:-->
<sessionId>125003101223.6634.326B.C412.41CD.8643.4190</sessionId>
</crud:getProductFile>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getProductFileResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud"
xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVCBYTUwgPT09PT09LS0+DQo8IS0tIDwhR
</return>
</ns2:getProductFileResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:          public javax.activation.DataHandler getProductFile(java.lang.String id,
                                                                                                                                java.lang.String filename,
                                                                                                                                java.lang.String sessionId)
                                                 throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                                 com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:                

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import javax.activation.DataHandler;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

DataHandler d=stub.getProductFile("0d2c6593-9482-483b-a913-9cef2be60d56", "testproductfile", "125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7");

 

putProductFile

Upload a file associated with a Product.

Parameters

Name Type Description
id
String
SKU of the Product
filename
String
name of the file to upload
data
DataHandler
DataHandler wrapping the file data
sessionId
String
sessionId of the current session

Returns

Name Type Description
Number Of Bytes
Long
the number of bytes uploaded

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:putProductFile>
<!--Optional:-->
<productId>0d2c6593-9482-483b-a913-9cef2be60d56</productId>
<!--Optional:-->
<filename>testproductfile</filename>
<!--Optional:-->
<data>cid:893016213814</data>
<!--Optional:-->
<sessionId>125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7</sessionId>
</crud:putProductFile>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:putProductFileResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>9</return>
</ns2:putProductFileResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:           public java.lang.Long putProductFile(java.lang.String id,
                                                                                                         java.lang.String filename,
                                                                                                         javax.activation.DataHandler data,
                                                                                                        java.lang.String sessionId)
                                         throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,                                          com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:                  

import javax.activation.DataHandler;
import javax.activation.DataSource;
import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Long size = 0L;
String where="ProductFile";
InputStream in= new FileInputStream("InputStreamToFile.txt");
DataSource dataSource = new DataSource() {

@Override
public InputStream getInputStream() throws IOException {
return in;
}

@Override
public OutputStream getOutputStream() throws IOException {
return null;
}

@Override
public String getContentType() {
return "application/octet-stream";
}

@Override
public String getName() {
return where;
}
};
DataHandler dataHandler = new DataHandler(dataSource);

filesize = stub.putProductFile("0d2c6593-9482-483b-a913-9cef2be60d56", where, dataHandler,
"25003101226.E179.E9D3.3DA5.4598.A2DE.C3A7");

 

deleteProductFile

Delete a file associated with a Product.

Parameters

Name Type Description
id
String
SKU of the Product
filename
String
name of the file to delete
sessionId
String
sessionId of the current session

Returns

Name Type Description
Number Of Bytes
Long
number of bytes deleted

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:deleteProductFile>
<!--Optional:-->
<productId>0d2c6593-9482-483b-a913-9cef2be60d56</productId>
<!--Optional:-->
<filename>testproductfile</filename>
<!--Optional:-->
<sessionId>125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7</sessionId>
</crud:deleteProductFile>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:deleteProductFileResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>10</return>
</ns2:deleteProductFileResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:         public java.lang.Long deleteProductFile (java.lang.String id,
                                                                                                             java.lang.String filename,
                                                                                                            java.lang.String sessionId)
                                        throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                       com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:                  

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

stub.deleteProductFile("0d2c6593-9482-483b-a913-9cef2be60d56", "testproductfile", "125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7");

 

createProvisioning

Create a new provisioning for a custom product. The product must be a custom product and controlled by the
user.

Parameters

Name Type Description
provisioning
Provisioning
the provisioning to create
sessionId
String
the sessionId of the current user session

Returns

Name Type Description
Provisioning
Provisioning
the newly persisted provisioning

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:createProvisioning>
<!--Optional:-->
<provisioning permissions="read" id="12625">
<!--Optional:-->
<owner id="171">shuckertestuser</owner>
<!--Optional:-->
<account>100</account>
<!--Optional:-->
<createdby>171</createdby>
<!--Optional:-->
<createddate>2011-11-1</createddate>
<!--Optional:-->
<expirationDate>2012-1-1</expirationDate>
<!--Optional:-->
<group>2</group>
<!--Optional:-->
<lastmodifiedby>171</lastmodifiedby>
<!--Optional:-->
<lastmodifieddate>2011-11-1</lastmodifieddate>
<!--Optional:-->
<name>testprovisioning</name>
<!--Optional:-->
<parameters>
<!--Zero or more repetitions:-->
<parameter key="key1" secure="true">value</parameter>
</parameters>
<!--Optional:-->
<process>testprocess.ip.xml</process>
<!--Optional:-->
<product>0d2c6593-9482-483b-a913-9cef2be60d100</product>
<!--Optional:-->
<productOwnedId>355</productOwnedId>
<!--Optional:-->
<schedule>0</schedule>
<!--Optional:-->
<startDate>2011-11-1</startDate>
<!--Optional:-->
<user>171</user>
</provisioning>
<!--Optional:-->
<sessionId>6b1b4e5e-6a9a-43f0-8e19-3e569efa0dec</sessionId>
</crud:createProvisioning>
</soapenv:Body>
< /soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:createProvisioningResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return id="44918" permissions="">
<owner id="171">shuckertestuser</owner>
<account>1</account>
<createdby>171</createdby>
<lastmodifiedby>171</lastmodifiedby>
<name>testprovisioning</name>
<parameters>
<parameter secure="true" key="key1"/>
</parameters>
<process>testprocess.ip.xml</process>
<product>0d2c6593-9482-483b-a913-9cef2be60d100</product>
<productOwnedId>355</productOwnedId>
<schedule>0</schedule>
<user>171</user>
</return>
</ns2:createProvisioningResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:    public com.pervasive.datasolutions.datacloud.persistence.ent.Provisioning                    createProvisioning(com.pervasive.datasolutions.datacloud.persistence.ent.Provisioning provisioning,
                                                                                                                                                            String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,

                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:                  

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import java.text.SimpleDateFormat;
import java.util.Date;

Provisioning pr=new Provisioning();

User u=new User();
pr.setCreatedby(u);
pr.setCreateddate((long) (2010-05-14));

Calendar expdate=Calendar.getInstance();

pr.setExpirationDate(expdate);
pr.setId(12086);
pr.setLastmodifiedby(u);
pr.setLastmodifieddate((long) (2010-06-14));
pr.setName("TestProvisioning");

UserInfo uf=new UserInfo();
uf.setId(172);
uf.set_value("testuser");

pr.setOwner(uf);
pr.setPermissions("READ");


pr.setProcess("Integration.ip.xml");
pr.setProduct("0d2c6593-9482-483b-a913-9cef2be60d55");
pr.setProductOwnedId("335");
pr.setSchedule("0");

Calendar startDate=Calendar.getInstance();

pr.setStartDate(startDate);
pr.setUser((long) 171);

pr.setGroup(2);
ProvisioningParameter[] prparameter=new ProvisioningParameter[5];
prparameter[0].setKey("provisioningKey");
prparameter[0].set_value("provisioningKeyValue");
prparameter[0].setSecure(true);

pr.setParameters(prparameter);
Provisioning prov = stub.createProvisioning(p, "125003101227.4253.DC58.5A73.4AC1.AED2.5687");

 

findProvisioning

Return a provisioning by id.

Parameters

Name Type Description
id
Long
id of the provisioning to return
sessionId
String
sessionId of the current session

Returns

Name Type Description
Provisioning
Provisioning
the Provisioning

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:findProvisioning>
<!--Optional:-->
<id>12086</id>
<!--Optional:-->
<sessionId>125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130</sessionId>
</crud:findProvisioning>
</soapenv:Body>
</soapenv:Envelope>  

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findProvisioningResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return id="12086">
<owner id="171">shuckertestuser</owner>
<expirationDate>2010-06-25T00:00:00-04:00</expirationDate>
<parameters>
<parameter key="asdgasdgasdg">asd</parameter>
<parameter key="metric.LastRun">2/01/2010 10:11:14</parameter>
</parameters>
<process>integrationSpec/createdestination (1).jpg</process>
<product>IDSSSBV-E01W201-91900-01</product>
<productOwnedId>a1730000000K26vAAC</productOwnedId>
<schedule>0</schedule>
<user>171</user>
</return>
</ns2:findProvisioningResponse>
</S:Body>
</S:Envelope>  

 

Java Code Sample

Method Signature:       public com.pervasive.datasolutions.datacloud.persistence.ent.Provisioning                                                                                                            findProvisioning(java.lang.Long id,
                                                                                                                      java.lang.String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,

                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException
i

 

Usage:                  

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Provisioning p = stub.findProvisioning(12086, "125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130");

 

editProvisioning

Edit a provisioning associated with a user.

Parameters

Name Type Description
provisioning
provisioning
the new value of the provisioning
sessionId
String
sessionId of the current session

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:editProvisioning>
<!--Optional:-->
<provisioning permissions="" id="12625">
<!--Optional:-->
<owner id="171">shuckertestuser</owner>
<!--Optional:-->
<account>100</account>
<!--Optional:-->
<createdby>171</createdby>
<!--Optional:-->
<createddate>2011-11-1</createddate>
<!--Optional:-->
<expirationDate>2012-1-1</expirationDate>
<!--Optional:-->
<group>2</group>
<!--Optional:-->
<lastmodifiedby>171</lastmodifiedby>
<!--Optional:-->
<lastmodifieddate>2011-11-1</lastmodifieddate>
<!--Optional:-->
<name>myProvisioning</name>
<!--Optional:-->
<parameters>
<!--Zero or more repetitions:-->
<parameter key="myProvisioningKey" secure="no">myProvisioningValue</parameter>
</parameters>
<!--Optional:-->
<process>testprocess.ip.xml</process>
<!--Optional:-->
<product>IDSSSBV-E01W201-91900-01</product>
<!--Optional:-->
<productOwnedId>a1730000000K4bxAAC</productOwnedId>
<!--Optional:-->
<schedule></schedule>
<!--Optional:-->
<startDate>?</startDate>
<!--Optional:-->
<user>47</user>
</provisioning>
<!--Optional:-->
<sessionId>82f379ab-44e4-4d04-b0da-7c11404cfd99</sessionId>
</crud:editProvisioning>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:editProvisioningResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity"/>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:       public void editProvisioning                                                                                                                                         (com.pervasive.datasolutions.datacloud.persistence.ent.Provisioning provisioning,
                                                                                                                                       String sessionId )
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:                 

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Provisioning pr=new Provisioning();

User u=new User();
pr.setCreatedby(u);
pr.setCreateddate((long) (2010-05-14));

Calendar expdate=Calendar.getInstance();

pr.setExpirationDate(expdate);
pr.setId(12086);
pr.setLastmodifiedby(u);
pr.setLastmodifieddate((long) (2010-06-14));
pr.setName("TestProvisioning");

UserInfo uf=new UserInfo();
uf.setId(172);
uf.set_value("testuser");

pr.setOwner(uf1);
pr.setPermissions("READ");

pr.setGroup(2);
pr.setProcess("Integration.ip.xml");
pr.setProduct("0d2c6593-9482-483b-a913-9cef2be60d55");
pr.setProductOwnedId("335");
pr.setSchedule("0");

Calendar startDate=Calendar.getInstance();

pr.setStartDate(startDate);
pr.setUser((long) 171);

ProvisioningParameter[] prparameter=new ProvisioningParameter[5];
prparameter[0].setKey("provisioningKey");
prparameter[0].set_value("provisioningKeyValue");
prparameter[0].setSecure(true);

pr.setParameters(prparameter);

stub.editProvisioning(p, "125003101227.4253.DC58.5A73.4AC1.AED2.5687");

 

listProvisionings

List the provisionings associated with the current user.

Parameters

Name Type Description
firstResults
Integer
0-indexed ordinal of the first record to return
maxResult
Integer
the maximum number of records to return
sessionId
String
sessionId of the current session

Returns

Name Type Description
Provisioning(0..*)
List<Provisioning>
list of provisionings

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:listProvisionings>
<!--Optional:-->
<firstResult>0</firstResult>
<!--Optional:-->
<maxResults>100</maxResults>
<!--Optional:-->
<sessionId>125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130</sessionId>
</crud:listProvisionings>
</soapenv:Body>
</soapenv:Envelope>  

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:listProvisioningsResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return id="12086">
<owner id="171">shuckertestuser</owner>
<expirationDate>2010-06-25T00:00:00-04:00</expirationDate>
<parameters>
<parameter key="asdgasdgasdg">asd</parameter>
<parameter key="metric.LastRun">2/01/2010 10:11:14</parameter>
</parameters>
<process>integrationSpec/createdestination (1).jpg</process>
<product>IDSSSBV-E01W201-91900-01</product>
<productOwnedId>a1730000000K26vAAC</productOwnedId>
<schedule>0</schedule>
<user>171</user>
</return>
<return id="42404">
<owner id="171">shuckertestuser</owner>
<expirationDate>2011-06-30T00:00:00-04:00</expirationDate>
<name>Report Storage datacloud2</name>
<parameters>
<parameter key="ODBC_SOURCE">prod-instancedb</parameter>
<parameter key="last.runtime">2010-12-22</parameter>
<parameter key="domain">datacloud2</parameter>
</parameters>
<process/>
<product>62db7b91-6749-4d2e-b6e9-5fa73bbcfe1b</product>
<schedule>00 2 * * 1,2,3,4,5,6,0</schedule>
<startDate>2010-12-07T00:00:00-05:00</startDate>
<user>171</user>
</return>
    .
    .
    .
    .
</ns2:listProvisioningsResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:        public java.util.List <com.pervasive.
datasolutions.datacloud.persistence.ent.Provisioning> listProvisioning(java.lang.Integer firstResults,
                                                                                       java.lang.Integer maxResult, java.lang.String sessionId )
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,

                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:              

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import java.util.List;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

List<Provisioning> prov = stub.listProvisionings(0, 100, "125003101223.6634.326B.C412.41CD.8643.4190");    

 

listProvisioningsByGroup

List the provisionings associated with the group .

Parameters

Name Type Description
firstResults
Integer
0-indexed ordinal of the first record to return
maxResult
Integer
the maximum number of records to return
id
Long
the group id
sessionId
String
sessionId of the current session

Returns

Name Type Description
Provisioning(0..*)
List<Provisioning>
list of provisionings

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:listProvisioningsByGroup>
<!--Optional:-->
<firstResult>1</firstResult>
<!--Optional:-->
<maxResults>1</maxResults>
<!--Optional:-->
<id>1</id>
<!--Optional:-->
<sessionId>560ee69a-c0cd-4f11-9579-4cda37be4220</sessionId>
</crud:listProvisioningsByGroup>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:listProvisioningsByGroupResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return id="12085" permissions="">
<owner id="47">testuser99</owner>
<account>1</account>
<expirationDate>2010-07-02T04:00:00Z</expirationDate>
<group>1</group>
<parameters>
<parameter key="SalesforceUserBasics.0.file.urijar"/>
<parameter key="SalesforceLeadBasics.1.combo.limit"/>
<parameter key="SalesforceContactBasics.1.combo.schedule"/>
<parameter key="SalesforceOpportunitiesBasics.1.textfield.username"/>
<parameter key="SalesforceContactBasics.1.textfield.username"/>
<parameter key="SalesforceAccountsBasics.1.password.password"/>
<parameter key="SalesforceContactBasics.1.combo.limit"/>
<parameter key="SalesforceUserBasics.1.combo.schedule"/>
<parameter key="SalesforceOpportunitiesBasics.0.file.urimeta"/>
<parameter key="SalesforceAccountsBasics.1.combo.limit"/>
<parameter key="SalesforceLeadBasics.1.password.password"/>
<parameter key="SalesforceUserBasics.1.password.password"/>
<parameter key="SalesforceOpportunitiesBasics.1.combo.limit"/>
<parameter key="SalesforceUserBasics.1.textfield.username"/>
<parameter key="SalesforceContactBasics.1.password.password"/>
<parameter key="SalesforceOpportunitiesBasics.1.password.password"/>
<parameter key="SalesforceOpportunitiesBasics.0.file.urijar"/>
<parameter key="SalesforceUserBasics.0.file.urimeta"/>
<parameter key="SalesforceLeadBasics.1.combo.schedule"/>
<parameter key="SalesforceLeadBasics.1.textfield.username"/>
<parameter key="SalesforceContactBasics.0.file.urimeta"/>
<parameter key="SalesforceAccountsBasics.1.textfield.username"/>
<parameter key="SalesforceLeadBasics.0.file.urimeta"/>
<parameter key="SalesforceAccountsBasics.0.file.urimeta"/>
<parameter key="SalesforceAccountsBasics.0.file.urijar"/>
<parameter key="SalesforceAccountsBasics.1.combo.schedule"/>
<parameter key="SalesforceContactBasics.0.file.urijar"/>
<parameter key="SalesforceUserBasics.1.combo.limit"/>
<parameter key="SalesforceLeadBasics.0.file.urijar"/>
<parameter key="SalesforceOpportunitiesBasics.1.combo.schedule"/>
</parameters>
<process/>
<product>IDSSSBV-E01W201-91900-01</product>
<productOwnedId>a1730000000K4bxAAC</productOwnedId>
<user>47</user>
</return>
</ns2:listProvisioningsByGroupResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:        List <com.pervasive.datasolutions.datacloud.persistence.ent.Provisioning>                                                                                                            listProvisioningsByGroup(Integer firstResults,
                                                                                       Integer maxResult,Long id, String sessionId )
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,

                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:              

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import java.util.List;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

List<Provisioning> prov = stub.listProvisioningsByGroup(0, 100, 2,"2bcd6cc0-bf9b-49c0-9fca-80742cc80df7");    

 

deleteProvisioning

Delete a provisioning by id. Only provisionings for user-controlled custom products can be deleted.

Parameters

Name Type Description
id
Long
id of the provisioning to delete
sessionId
String
sessionId of the current session

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:deleteProvisioning>
<!--Optional:-->
<id>43144</id>
<!--Optional:-->
<sessionId>125003101227.4253.DC58.5A73.4AC1.AED2.5687</sessionId>
</crud:deleteProvisioning>
</soapenv:Body>
</soapenv:Envelope>  

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:deleteProvisioningResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity"/>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:       public void deleteProvisioning(java.lang.Long id, java.lang.String sessionId)
                                             throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                             com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:      

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

stub.deleteProvisioning(12086, "125003101227.4253.DC58.5A73.4AC1.AED2.5687");

 

getProvisioningCount

Count the Provisionings associated with the current user.

Parameters

Name Type Description
sessionId
String
sessionId of the current session

Returns

Name Type Description
Provisioning Count
Long
count of Provisionings

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:getProvisioningCount>
<!--Optional:-->
<sessionId>125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130</sessionId>
</crud:getProvisioningCount>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getProvisioningCountResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>35</return>
</ns2:getProvisioningCountResponse>
</S:Body>
</S:Envelope>  

 

Java Code Sample

Method Signature:       public java.lang.Long getProvisioningCount(java.lang.String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:      

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Long Count=stub.getProvisioningCount("125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130");

 

getProvisioningParameter

Return the value of a parameter associated with a provisioning referenced by id.

Parameters

Name Type Description
id
Long
the id of the provisioning
key
String
the key of the parameter to return
sessionId
String
sessionId of the current session

Returns

Name Type Description
Parameter Value
String
the value of the parameter

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:getProvisioningParameter>
<!--Optional:-->
<id>12086</id>
<!--Optional:-->
<key>provisioningkey</key>
<!--Optional:-->
<sessionId>125003101223.6634.326B.C412.41CD.8643.4190</sessionId>
</crud:getProvisioningParameter>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body>
<ns2:getProvisioningParameterResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>provisioningvalue</return>
</ns2:getProvisioningParameterResponse> </S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:      public java.lang.String getProvisioningParameter(java.lang.Long id,
                                                                                                        java.lang.String key,java.lang.String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:      

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

String ProvisioningParameter=stub.getProvisioningParameter(12086, "provisioningkey", "125003101223.6634.326B.C412.41CD.8643.4190");

 

putProvisioningParameter

Store a key/value pair associated with a Provisioning identified by id.

Parameters

Name Type Description
id
Long
the id of the Provisioning
key
String
the key of the parameter
value
String
the value of the parameter
sessionId
String
sessionId of the current session

Returns

Name Type Description
Parameter Value
String
the old value of the parameter, or null if it is a new parameter

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:putProvisioningParameter>
 <!--Optional:-->
<id>12086</id>
 <!--Optional:-->
<key>provisioningkey</key>
 <!--Optional:-->
<value>provisioningvalue</value>
<!--Optional:-->
<sessionId>125003101223.6634.326B.C412.41CD.8643.4190</sessionId>
</crud:putProvisioningParameter>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:putProvisioningParameterResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity"/>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:      public java.lang.String putProvisioningParameter(java.lang.Long id,
                                                                 java.lang.String key,java.lang.String value,java.lang.String sessionId)                                                throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:      

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

String ProvisioningParameter=stub.putProvisioningParameter(12086, "provisioningkey", "provisioningvalue", "125003101227.4253.DC58.5A73.4AC1.AED2.5687");

 

removeProvisioningParameter

Remove a parameter from a Provisioning

Parameters

Name Type Description
id
Long
the id of the Provisioning from which to remove a parameter
key
String
the key of the parameter
sessionId
String
sessionId of the current session

Returns

Name Type Description
Parameter Value
Stirng
the old value of the parameter

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:removeProvisioningParameter>
<!--Optional:-->
<id>12086</id>
<!--Optional:-->
<key>provisioningkey</key>
<!--Optional:-->
<sessionId>125003101223.6634.326B.C412.41CD.8643.4190</sessionId>
</crud:removeProvisioningParameter>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:removeProvisioningParameterResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>provisioningvalue</return>
</ns2:removeProvisioningParameterResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:    public java.lang.String removeProvisioningParameter(java.lang.Long id,
                                                                                       java.lang.String key,java.lang.String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,

                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:      

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

String ParameterValue=stub.removeProvisioningParameter(12086, "provisioningkey", "125003101227.4253.DC58.5A73.4AC1.AED2.5687");

 

listProvisioningFiles

List files associated with a Provisioning.

Parameters

Name Type Description
id
Long
id of the Provisioning
sessionId
String
sessionId of the current session

Returns

Name Type Description
File Names
List<java.lang.String>
List of filenames associated with the Provisioning

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:listProvisioningFiles>
<!--Optional:-->
<provisioningId>12086</provisioningId>
<!--Optional:-->
<sessionId>125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130</sessionId>
</crud:listProvisioningFiles>
</soapenv:Body>
</soapenv:Envelope>  

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:listProvisioningFilesResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>integrationSpec/createdestination (1).jpg</return>
<return>integrationSpec/loading.gif</return>
<return>license/pv90S122-222361_20100625</return>
<return>log/0117c8e5-f924-451c-bf79-cd70341b7725</return>
<return>log/014eca66-0dc5-4aa5-b84d-8e30f280cccb</return>
<return>log/01e6f5cc-e884-439f-9201-b4f54d04920e</return>
<return>log/ffc4fba3-3014-4b07-ba0f-488bc97905cb</return>
</ns2:listProvisioningFilesResponse>
</S:Body>
</S:Envelope>  

 

Java Code Sample

Method Signature:         public java.util.List<java.lang.String> listProvisioningFiles(java.lang.Long id,
                                                                                                                                            java.lang.String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,

                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:      

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import java.util.List;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

List<String> provisioningfiles = stub.listProvisioningFiles(12086, "125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA");

 

getProvisioningFile

Download a file associated with a Provisioning.

Parameters

Name Type Description
id
Long
id of the Provisioning
filename
String
name of the file to download
sessionId
String
sessionId of the current session

Returns

Name Type Description
Provisioning File
DataHandler
DataHandler wrapping the file data

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:getProvisioningFile>
<!--Optional:-->
<provisioningId>12086</provisioningId>
<!--Optional:-->
<filename>integrationSpec/createdestination (1).jpg</filename>
<!--Optional:-->
<sessionId>125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130</sessionId>
</crud:getProvisioningFile>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getProvisioningFileResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>/9j/4AAQSkZJRgABAgAAZABkAAD/7AARRHVja3kAAQAEAAAAPAAA/+4ADkFkb2Jl</return>
</ns2:getProvisioningFileResponse>
</S:Body>

 

Java Code Sample

Method Signature:      public javax.activation.DataHandler getProvisioningFile(java.lang.Long id,
                                                                                                java.lang.String filename,java.lang.String sessionId)
                                                 throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,

                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:      

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import javax.activation.DataHandler;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

DataHandler fileHandlr = null;
fileHandlr = stub.getProvisioningFile(12086, "ntegrationSpec/createdestination (1).jpg","125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130" );

 

putProvisioningFile

Upload a file associated with a Provisioning.

Parameters

Name Type Description
id
Long
id of the Provisioning
filename
String
name of the file to upload
data
DataHandler
DataHandler wrapping the file data
sessionId
String
sessionId of the current session

Returns

Name Type Description
Number Of Bytes
Long
number of bytes uploaded

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:putProvisioningFile>
<!--Optional:-->
<provisioningId>12086</provisioningId>
<!--Optional:-->
<filename>log/0117c8e5-f924-451c-bf79-cd70341b7725</filename>
<!--Optional:-->
<data>cid:561262630752</data>
<!--Optional:-->
<sessionId>125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130</sessionId>
</crud:putProvisioningFile>
</soapenv:Body>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:putProvisioningFileResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>9</return>
</ns2:putProvisioningFileResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:     public java.lang.Long putProvisioningFile(java.lang.Long id,
                                                                                                          java.lang.String filename,                                                                                                                                              javax.activation.DataHandler data,
                                                                                                         java.lang.String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,

                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:                

import javax.activation.DataHandler;
import javax.activation.DataSource;
import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Long size = 0L;
String where="ProvisioningFile";
InputStream in= new FileInputStream("InputStreamToFile.txt");
DataSource dataSource = new DataSource() {

@Override
public InputStream getInputStream() throws IOException {
return in;
}

@Override
public OutputStream getOutputStream() throws IOException {
return null;
}

@Override
public String getContentType() {
return "application/octet-stream";
}

@Override
public String getName() {
return where;
}
};
DataHandler dataHandler = new DataHandler(dataSource);
size = stub.putProvisioningFile(12086, where, dataHandler, "125003101223.6634.326B.C412.41CD.8643.4190");

 

deleteProvisioningFile

Delete a file associated with a Provisioning.

Parameters

Name Type Description
id
Long
id of the Provisioning
filename
String
name of the file to delete
sessionId
String
sessionId of the current session

Returns

Name Type Description
Number Of Bytes
Long
number of bytes deleted

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:deleteProvisioningFile>
<!--Optional:-->
<provisioningId>12086</provisioningId>
<!--Optional:-->
<filename>testfile</filename>
<!--Optional:-->
<sessionId>125003101227.4253.DC58.5A73.4AC1.AED2.5687</sessionId>
</crud:deleteProvisioningFile>
</soapenv:Body>
</soapenv:Envelope>  

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:deleteProvisioningFileResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>10</return>
</ns2:deleteProvisioningFileResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:      public java.lang.Long deleteProvisioningFile(java.lang.Long id,
                                                                                      java.lang.String filename, java.lang.String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,

                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:      

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Long bytesdeleted=stub.deleteProvisioningFile(12086, "testfile", "125003101227.4253.DC58.5A73.4AC1.AED2.5687");

 

createCredential

Creates a custom Credential object associated with a User Takes the credential to instantiate and the sessionId of the logged in user as arguments login(String, String).

Parameters

Name Type Description
credential
Credential
the credential to create
sessionId
String
the sessionId associated with the currently logged in user

Returns

Name Type Description
Credential
Credential
the credential created

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:createCredential>
<!--Optional:-->
<credential id="2958500">
<!--Optional:-->
<owner id="171">shuckertestuser</owner>
<!--Optional:-->
<account>100</account>
<!--Optional:-->
<expiration>2012-11-24T00:00:00-04:00</expiration>
<!--Optional:-->
<group>150</group>
<!--Optional:-->
<parameters>
<!--Zero or more repetitions:-->
<parameter key="myCredentialParamKey" secure="no">myCredentialParamVelua</parameter>
</parameters>
<!--Optional:-->
<type>testing</type>
</credential>
<!--Optional:-->
<sessionId>82f379ab-44e4-4d04-b0da-7c11404cfd99</sessionId>
</crud:createCredential>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:createCredentialResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return id="2992124">
<owner id="171">shuckertestuser</owner>
<account>1</account>
<expiration>2012-11-24T04:00:00Z</expiration>
<parameters>
<parameter key="myCredentialParamKey">myCredentialParamVelua</parameter>
</parameters>
<type>testing</type>
</return>
</ns2:createCredentialResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:         public com.pervasive.datasolutions.datacloud.persistence.ent.Credential                                                                              createCredential(com.pervasive.datasolutions.datacloud.persistence.ent.
                                                                              Credential credential, String sessionId)
                                            throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                            com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException
 

 

Usage:                

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Credential c= new Credential();
Calendar expdate=Calendar.getInstance();

c.setGroup(2);

c.setExpiration(expdate);
c.setId(2991618);

UserInfo uf=new UserInfo();
uf.setId(172);
uf.set_value("testuser");
c.setOwner(uf);

CredentialParameter[] cparameter=new CredentialParameter[5];
cparameter[0].set_value("CrednetialKeyValue");
cparameter[0].setKey("CrednetialKey");
cparameter[0].setSecure(true);

c.setParameters(cparameter);
c.setType("executionSession");

Credential c=stub.createCredential(credential, "125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7");

 

findCredential

Return a credential by id, must be associated with the user.

Parameters

Name Type Description
id
Long
id of the credential to return
sessionId
String
sessionId of the current session

Returns

Name Type Description
Credential
Credential
the credential corresponding to the id

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:findCredential>
<!--Optional:-->
<id>1675857</id>
<!--Optional:-->
<sessionId>125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130</sessionId>
</crud:findCredential>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findCredentialResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return id="1675857">
<owner id="171">shuckertestuser</owner>
<expiration>2010-12-22T13:43:32.001-05:00</expiration>
<parameters>
<parameter key="visitorKey">1012F496D9A760394049</parameter>
<parameter key="sessionId">125003101221.BF38.43E4.CD9B.4A4D.9004.1748</parameter>
</parameters>
<type>pervasiveSession</type>
</return>
</ns2:findCredentialResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:         public com.pervasive.datasolutions.datacloud.persistence.ent.Credential                                                           findCredential(java.lang.Long id, java.lang.String sessionId)
                                           throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                           com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Credential credential=stub.findCredential(1675857, "125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130");

 

editCredential

Edit a credential associated with the user

Parameters

Name Type Description
credential
Credential
the new value of the credential to be edited
sessionId
String
sessionId of the current session

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:editCredential>
<!--Optional:-->
<credential id="2992124">
<!--Optional:-->
<owner id="171">shuckertestuser</owner>
<!--Optional:-->
<account>100</account>
<!--Optional:-->
<expiration>2011-11-02T00:00:00-04:00</expiration>
<!--Optional:-->
<group>150</group>
<!--Optional:-->
<parameters>
<!--Zero or more repetitions:-->
<parameter key="testKey" secure="no">testValue</parameter>
</parameters>
<!--Optional:-->
<type>development</type>
</credential>
<!--Optional:-->
<sessionId>82f379ab-44e4-4d04-b0da-7c11404cfd99</sessionId>
</crud:editCredential>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:editCredentialResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity"/>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:             public void editCredential(com.pervasive.datasolutions.datacloud.persistence.ent.                                                                                                                   Credential credential, String sessionId)
                                           throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                           com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:                

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Credential c= new Credential();
Calendar expdate=Calendar.getInstance();

c.setExpiration(expdate);
c.setId(2991618);

UserInfo uf=new UserInfo();
uf.setId(172);
uf.set_value("testuser");
c.setOwner(uf);

c.setGroup(2);

CredentialParameter[] cparameter=new CredentialParameter[5];
cparameter[0].set_value("CrednetialKeyValue");
cparameter[0].setKey("CrednetialKey");
cparameter[0].setSecure(true);

c.setParameters(cparameter);
c.setType("executionSession");


stub.editCredential(credential, "125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130");

 

listCredentials

List the credentials associated with the current user

Parameters

Name Type Description
firstResults
Integer
0-indexed ordinal of the first record to return
maxResult
Integer
the maximum number of records to return
sessionId
String
sessionId of the current session

Returns

Name Type Description
Credential (0..*)
List<Credential>
a list of credentials

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:listCredentials>
<!--Optional:-->
<firstResult>0</firstResult>
<!--Optional:-->
<maxResults>100</maxResults>
<!--Optional:-->
<sessionId>125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130</sessionId>
</crud:listCredentials>
</soapenv:Body>
</soapenv:Envelope>   

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:listCredentialsResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return id="1675857">
<owner id="171">shuckertestuser</owner>
<expiration>2010-12-22T13:43:32.001-05:00</expiration>
<parameters>
<parameter key="visitorKey">1012F496D9A760394049</parameter>
<parameter key="sessionId">125003101221.BF38.43E4.CD9B.4A4D.9004.1748</parameter>
</parameters>
<type>pervasiveSession</type>
</return>
<return id="1675885">
<owner id="171">shuckertestuser</owner>
<expiration>2010-12-22T08:30:21.861-05:00</expiration>
<parameters>
<parameter key="visitorKey">10126E2C3AE403A3452B</parameter>
<parameter key="sessionId">125003101221.8504.7395.A215.4D52.B497.465C</parameter>
</parameters>
<type>pervasiveSession</type>
</return>
<return id="1676346">
<owner id="171">shuckertestuser</owner>
<expiration>2010-12-22T12:52:10.265-05:00</expiration>
<parameters>
<parameter key="sessionId">125003101222.0983.1D44.8AB4.447E.ADD9.9FDE</parameter>
<parameter key="visitorKey">1012ADCEC4C7289D447D</parameter>
</parameters>
<type>pervasiveSession</type>
</return>
      .
      .
      .
</ns2:listCredentialsResponse>
</S:Body>
</S:Envelope>  

 

Java Code Sample

Method Signature:         public java.util.List<com.pervasive.datasolutions.datacloud.persistence.ent.Credential>                                                          listCredentials(java.lang.Integer firstResults, java.lang.Integer maxResult,                                                                                                                                        java.lang.String sessionId)
                                          throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                          com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import java.util.List;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

List <Credential> credentials=stub.listCredentials(0, 100, "125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130");

 

listCredentialsByGroup

List the credentials associated with the group.

Parameters

Name Type Description
firstResults
Integer
0-indexed ordinal of the first record to return
maxResult
Integer
the maximum number of records to return
id
Long
the group id
sessionId
String
sessionId of the current session

Returns

Name Type Description
Credential (0..*)
List<Credential>
a list of credentials

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:listCredentialsByGroup>
<!--Optional:-->
<firstResult>0</firstResult>
<!--Optional:-->
<maxResults>10</maxResults>
<!--Optional:-->
<id>150</id>
<!--Optional:-->
<sessionId>82f379ab-44e4-4d04-b0da-7c11404cfd99</sessionId>
</crud:listCredentialsByGroup>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:listCredentialsByGroupResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity"/>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:    List<com.pervasive.datasolutions.datacloud.persistence.ent.Credential>                                                                   listCredentialsByGroup(Integer firstResults, Integer maxResult, Long id,String sessionId)
                                          throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                          com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import java.util.List;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

List <Credential> credentials=stub.listCredentialsByGroup(0, 100, 2,"34f1befe-a322-411f-aa68-e8f10c22c750");

 

deleteCredential

Delete a credential by id

Parameters

Name Type Description
id
Long
the id of the credential to delete
sessionId
String
the sessionId of the current user session

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:deleteCredential>
<!--Optional:-->
<id>1690765</id>
<!--Optional:-->
<sessionId>125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7</sessionId>
</crud:deleteCredential>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:deleteCredentialResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity"/>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:      public void deleteCredential(java.lang.Long id,java.lang.String sessionId)
                                               throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                               com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException


Usage:

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

stub.deleteCredential(1690765, "125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7");

 

getCredentialCount

Count the Credentials associated with the current user.

Parameters

Name Type Description
sessionId
String
sessionId of the current session

Returns

Name Type Description
Credential Count
Long
count of credentials

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:getCredentialCount>
<!--Optional:-->
<sessionId>125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130</sessionId>
</crud:getCredentialCount>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getCredentialCountResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>12</return>
</ns2:getCredentialCountResponse>
</S:Body>
</S:Envelope>  

 

Java Code Sample

Method Signature:       public java.lang.Long getCredentialCount(java.lang.String sessionId)
                                         throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                         com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

long count=stub.getCredentialCount("125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA");

 

getCredentialParameter

Return the value of a parameter associated with a credential referenced by id

Parameters

Name Type Description
Id
Long
the id of the credential
key
String
key of the parameter to return
sessionId
String
sessionId of the current session

Returns

Name Type Description
Parameter Value
String
the value of the parameter associated with key

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:getCredentialParameter>
<!--Optional:-->
<id>1688381</id>
<!--Optional:-->
<key>parameterkey</key>
<!--Optional:-->
<sessionId>125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7</sessionId>
</crud:getCredentialParameter>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getCredentialParameterResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>parametervalue</return>
</ns2:getCredentialParameterResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:      public java.lang.String getCredentialParameter(java.lang.Long id, java.lang. String key,
                                                                                                                                          java.lang.String sessionId)
                                         throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                         com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:                

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

String parametervalue=stub.getCredentialParameter(1679455, "testcretentialparameter", "125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA");

 

putCredentialFile

Upload a file associated with a Credential.

Parameters

Name Type Description
Id
Long
the id of the credential
filename
String
filename of the file
data
DataHandler
DataHandler wrapping the file data
sessionId
String
sessionId of the current session

Returns

Name Type Description
Number Of Bytes
Long
number of bytes written

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:putCredentialFile>
<!--Optional:-->
<credentialId>1679239</credentialId>
<!--Optional:-->
<filename>credential file</filename>
<!--Optional:-->
<data>cid:1094948532470</data>
<!--Optional:-->
<sessionID>125003101223.6634.326B.C412.41CD.8643.4190</sessionID>
</crud:putCredentialFile>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:putCredentialFileResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>12</return>
</ns2:putCredentialFileResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:    public java.lang.Long putCredentialFile(java.lang.Long id, java.lang.String filename,
                                                                                                       javax.activation.DataHandler data,
                                                                                                       java.lang.String sessionId)
                                         throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                         com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:                    

import javax.activation.DataHandler;
import javax.activation.DataSource;
import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Long size = 0L;
String where=CredentialFile";
InputStream in= new FileInputStream("InputStreamToFile.txt");
DataSource dataSource = new DataSource() {

@Override
public InputStream getInputStream() throws IOException {
return in;
}

@Override
public OutputStream getOutputStream() throws IOException {
return null;
}

@Override
public String getContentType() {
return "application/octet-stream";
}

@Override
public String getName() {
return where;
}
};
DataHandler dataHandler = new DataHandler(dataSource);

size =stub.putCredentialFile(1688381, where, dataHandler, "125003101229.F1BE.46B1.1DA3.4544.A25F.69E8");

 

removeCredentialParameter

Remove a parameter from a Credential.

Parameters

Name Type Description
Id
Long
the id of the credential from which to remove a parameter
key
String
the key of the parameter
sessionId
String
sessionId of the current session

Returns

Name Type Description
Parameter Value
String
the old value of the parameter

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:removeCredentialParameter>
<!--Optional:-->
<id>1679455</id>
<!--Optional:-->
<key>testcretentialparameter</key>
<!--Optional:-->
<sessionId>125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA</sessionId>
</crud:removeCredentialParameter>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:removeCredentialParameterResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>testcretentialparametervalue</return>
</ns2:removeCredentialParameterResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:    public java.lang.String removeCredentialParameter(java.lang.Long id,
                                                                                                                         java.lang.String key,
                                                                                                                        java.lang.String sessionId)
                                         throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                         com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:                    

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

String parametervalue=stub.removeCredentialParameter(1679455, "testcretentialparameter", "125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA");

 

listCredentialFiles

List the files associated with a Credential.

Parameters

Name Type Description
Id
Long
the id of the credential
sessionId
String
sessionId of the current session

Returns

Name Type Description
File Names
List<java.lang.String>
List of filenames available to download

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:listCredentialFiles>
<!--Optional:-->
<credentialId>1679239</credentialId>
<!--Optional:-->
<sessionID>125003101223.6634.326B.C412.41CD.8643.4190</sessionID>
</crud:listCredentialFiles>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:listCredentialFilesResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>credential file1</return>
<return>credential file2</return>
</ns2:listCredentialFilesResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:       public java.util.List<java.lang.String> listCredentialFiles(java.lang.Long id,                                                                                                                                                   java.lang.String sessionId)
                                         throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                         com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:                  

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import java.util.List;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

List <String> listfiles=stub.listCredentialFiles(1692952, "125003110103.42D1.3564.C437.4893.9EEB.686A");

 

getCredentialFile

Download a file associated with a Credential.

Parameters

Name Type Description
Id
Long
the id of the credential
filename
String
filename to download
sessionId
String
sessionId of the current session

Returns

Name Type Description
Credential File
DataHandler
DataHandler wrapping the file data

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:getCredentialFile>
<!--Optional:-->
<credentialId>1679239</credentialId>
<!--Optional:-->
<filename>credential file</filename>
<!--Optional:-->
<sessionID>125003101223.6634.326B.C412.41CD.8643.4190</sessionID>
</crud:getCredentialFile>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getCredentialFileResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>cid1094948532470</return>
</ns2:getCredentialFileResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:       public javax.activation.DataHandler getCredentialFile(java.lang.Long id,                                                                                                                                                        java.lang.String filename,                                                                                                                                               java.lang.String sessionId)
                                         throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                         com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:                  

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import javax.activation.DataHandler;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

DataHandler fileHandlr = null;
fileHandlr=stub.getCredentialFile(1679239, "credential file", "125003101223.6634.326B.C412.41CD.8643.4190");

 

putCredentialParameter

Store a key/value pair associated with a credential identified by id

Parameters

Name Type Description
Id
Long
the id of the credential
key
String
the key of the parameter
value
String
the value of the parameter
sessionId
String
sessionId of the current session

Returns

Name Type Description
Parameter Value
String
the old value of the parameter, or null if it is a new parameter

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:putCredentialParameter>
<!--Optional:-->
<id>1679455</id>
<!--Optional:-->
<key>testcretentialparameter2</key>
<!--Optional:-->
<value>testvalue2</value>
<!--Optional:-->
<sessionId>125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA</sessionId>
</crud:putCredentialParameter>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:putCredentialParameterResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity"/>
</S:Body>
</S:Envelope>

Java Code Sample

Method Signature:    public java.lang.String putCredentialParameter(java.lang.Long id,java.lang.String key,
                                                                                                                   java.lang.String value,                                                                                                                                                java.lang.String sessionId)                                                                     throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

String parametervalue=stub.putCredentialParameter(1679455, "testcretentialparameter", "testparametervalue", "125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA");

 

deleteCredentialFile

Delete a file associated with a Credential.

Parameters

Name Type Description
Id
Long
the id of the credential
filename
String
filename to delete
sessionId
String
sessionId of the current session

Returns

Name Type Description
Number Of Bytes
Long
number of bytes deleted

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:deleteCredentialFile>
<!--Optional:-->
<credentialId>1688381</credentialId>
<!--Optional:-->
<filename>credentialfile</filename>
<!--Optional:-->
<sessionID>125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7</sessionID>
</crud:deleteCredentialFile>
</soapenv:Body>
</soapenv:Envelope> 

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:deleteCredentialFileResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>10</return>
</ns2:deleteCredentialFileResponse>
</S:Body>
</S:Envelope> 

 

Java Code Sample

Method Signature:       public java.lang.Long.deleteCredentialFile(java.lang.Long id,                                                                                                                                                      java.lang.String filename,                                                                                                                                                 java.lang.String sessionId)                                                                 throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                          com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:                 

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Long bytesdeleted=stub.deleteCredentialFile(1692952, "credentialfile", "125003110103.42D1.3564.C437.4893.9EEB.686A");

 

createDestination

Create a custom destination associated with a user

Parameters

Name Type Description
destination
Destination
the destination to create
sessionId
String
the currently active sessionId

Returns

Name Type Description
Destination
Destination
the newly created destination object

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:createDestination>
<!--Optional:-->
<destination id="165">
<!--Optional:-->
<owner id="171">shuckertestuser</owner>
<!--Optional:-->
<account>100</account>
<!--Optional:-->
<amiId>ami-c75daaae</amiId>
<!--Optional:-->
<availabilityzone>US-East-1a</availabilityzone>
<!--Optional:-->
<concurrency>5</concurrency>
<!--Optional:-->
<createdby>171</createdby>
<!--Optional:-->
<createddate>2011-11-02T04:00:00Z</createddate>
<!--Optional:-->
<deleted>false</deleted>
<!--Optional:-->
<destinationos>tiara</destinationos>
<!--Optional:-->
<destinationversion>1.0</destinationversion>
<!--Optional:-->
<engine>cosmos.v9</engine>
<!--Optional:-->
<group>31</group>
<!--Optional:-->
<instanceType>c1.xlarge </instanceType>
<!--Optional:-->
<keyName>cloud-key</keyName>
<!--Optional:-->
<lastmodifiedby>171</lastmodifiedby>
<!--Optional:-->
<lastmodifieddate>2011-11-01T04:00:00Z</lastmodifieddate>
<!--Optional:-->
<maxInstances>10</maxInstances>
<!--Optional:-->
<minInstances>0</minInstances>
<!--Optional:-->
<parameters>
<!--Zero or more repetitions:-->
<parameter key="myDestiantionParamKey" secure="no">myDestinationParamValue</parameter>
</parameters>
<!--Optional:-->
<platform>LINUX</platform>
<!--Optional:-->
<queueLowerThreshold>0</queueLowerThreshold>
<!--Optional:-->
<queueUpperThreshold>1</queueUpperThreshold>
<!--Optional:-->
<securityGroup>Default</securityGroup>
<!--Optional:-->
<sqsQueuePrefix>shuckertestuser-nonscaling</sqsQueuePrefix>
<!--Optional:-->
<userDataTemplateName>userdata.sh</userDataTemplateName>
</destination>
<!--Optional:-->
<sessionId>82f379ab-44e4-4d04-b0da-7c11404cfd99</sessionId>
</crud:createDestination>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:createDestinationResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return id="476">
<owner id="171">shuckertestuser</owner>
<account>1</account>
<amiId>ami-c75daaae</amiId>
<availabilityzone>US-East-1a</availabilityzone>
<concurrency>5</concurrency>
<createdby>171</createdby>
<deleted>false</deleted>
<destinationos>tiara</destinationos>
<destinationversion>1.0</destinationversion>
<engine>cosmos.v9</engine>
<group>31</group>
<instanceType>c1.xlarge</instanceType>
<keyName>cloud-key</keyName>
<lastmodifiedby>171</lastmodifiedby>
<maxInstances>10</maxInstances>
<minInstances>0</minInstances>
<parameters>
<parameter key="myDestiantionParamKey">myDestinationParamValue</parameter>
</parameters>
<platform>LINUX</platform>
<queueLowerThreshold>0</queueLowerThreshold>
<queueUpperThreshold>1</queueUpperThreshold>
<securityGroup>Default</securityGroup>
<sqsQueuePrefix>shuckertestuser-nonscaling</sqsQueuePrefix>
<userDataTemplateName>userdata.sh</userDataTemplateName>
</return>
</ns2:createDestinationResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:      public com.pervasive.datasolutions.datacloud.persistence.ent.Destination                         createDestination(com.pervasive.datasolutions.datacloud.persistence.ent.Destination destination,
                                                                                                                                           String sessionId)
                                           throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                           com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException
 

 

Usage:              

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Destination d=new Destination();
User u=new User();
d.setAmiId("c75daaae");
d.setAvailabilityzone("US-East-1a");
d.setConcurrency(4);
d.setCreatedby(u);
d.setCreateddate((long) (2010-05-14));
d.setDeleted(true);
d.setDestinationos("Windows");
d.setDestinationversion("v2");
d.setEngine("cosmos.v9");
d.setGroup(g);
d.setId(73);
d.setInstanceType("c1.xlarge");
d.setKeyName("cloud-key");
d.setGroup(2);
d.setLastmodifiedby(u);
d.setLastmodifieddate((long) (2010-05-14));
d.setMaxInstances(5);

UserInfo uf=new UserInfo();
uf.setId(172);
uf.set_value("testuser");
d.setOwner(uf);
d.setMinInstances(1);

DestinationParameter[] dparameter=new DestinationParameter[5];
dparameter[0].setKey("DestinationKey");
dparameter[0].set_value("DestinationKeyValue");
dparameter[0].setSecure(true);

d.setParameters(dparameter);

d.setPlatform(Platform.fromString("WINDOWS"));

d.setQueueLowerThreshold(0);
d.setQueueUpperThreshold(1);
d.setSecurityGroup("default");
d.setSqsQueuePrefix("shuckertestuser-nonscaling");
d.setUserDataTemplateName("userdata.sh");

Destination destination = stub.createDestination(d, "125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7");

 

findDestination

Return a destination by id

Parameters

Name Type Description
id
Long
id of the destination to return
sessionId
String
sessionId of the current session

Returns

Name Type Description
Destination
Destination
the destination

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:findDestination>
<!--Optional:-->
<id>73</id>
<!--Optional:-->
<sessionId>125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130</sessionId>
</crud:findDestination>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findDestinationResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return id="73">
<owner id="171">shuckertestuser</owner>
<amiId>ami-c75daaae</amiId>
<availabilityzone>US-East-1a</availabilityzone>
<concurrency>4</concurrency>
<engine>cosmos.v9</engine>
<instanceType>c1.xlarge</instanceType>
<keyName>cloud-key</keyName>
<maxInstances>0</maxInstances>
<minInstances>0</minInstances>
<parameters>
<parameter key="?"/>
</parameters>
<queueLowerThreshold>0</queueLowerThreshold>
<queueUpperThreshold>1</queueUpperThreshold>
<securityGroup>default</securityGroup>
<sqsQueuePrefix>shuckertestuser-nonscaling</sqsQueuePrefix>
<userDataTemplateName>userdata.sh</userDataTemplateName>
</return>
</ns2:findDestinationResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:         public com.pervasive.datasolutions.datacloud.persistence.ent.Destination                                                                                  findDestination(java.lang.Long id, java.lang.String sessionId)
                                           throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                           com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:                

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Destination d = stub.findDestination(254, "125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7");

 

editDestination

Edit a destination object associated with the user

Parameters

Name Type Description
destination
Destination
the new value of the destination object
sessionId
String
sessionId of the current session

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:editDestination>
<!--Optional:-->
<destination id="476">
<!--Optional:-->
<owner id="171">shuckertestuser</owner>
<!--Optional:-->
<account>100</account>
<!--Optional:-->
<amiId>ami-c75daaae</amiId>
<!--Optional:-->
<availabilityzone>US-East-1a</availabilityzone>
<!--Optional:-->
<concurrency>5</concurrency>
<!--Optional:-->
<createdby>171</createdby>
<!--Optional:-->
<createddate>2011-11-02T04:00:00Z</createddate>
<!--Optional:-->
<deleted>false</deleted>
<!--Optional:-->
<destinationos>pervasive</destinationos>
<!--Optional:-->
<destinationversion>1.0</destinationversion>
<!--Optional:-->
<engine>cosmos.v9</engine>
<!--Optional:-->
<group>31</group>
<!--Optional:-->
<instanceType>c1.xlarge </instanceType>
<!--Optional:-->
<keyName>cloud-key</keyName>
<!--Optional:-->
<lastmodifiedby>171</lastmodifiedby>
<!--Optional:-->
<lastmodifieddate>2011-11-01T04:00:00Z</lastmodifieddate>
<!--Optional:-->
<maxInstances>10</maxInstances>
<!--Optional:-->
<minInstances>0</minInstances>
<!--Optional:-->
<parameters>
<!--Zero or more repetitions:-->
<parameter key="mytestKey" secure="no">myTestValue</parameter>
</parameters>
<!--Optional:-->
<platform>LINUX</platform>
<!--Optional:-->
<queueLowerThreshold>0</queueLowerThreshold>
<!--Optional:-->
<queueUpperThreshold>1</queueUpperThreshold>
<!--Optional:-->
<securityGroup>Default</securityGroup>
<!--Optional:-->
<sqsQueuePrefix>shuckertestuser-nonscaling</sqsQueuePrefix>
<!--Optional:-->
<userDataTemplateName>userdata.sh</userDataTemplateName>
</destination>
<!--Optional:-->
<sessionId>82f379ab-44e4-4d04-b0da-7c11404cfd99</sessionId>
</crud:editDestination>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:editDestinationResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity"/>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature: public void editDestination(com.pervasive.datasolutions.datacloud.persistence.ent.                                                                                                              Destination destination, String sessionId)
                                           throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                           com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:                 

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Destination d=new Destination();

d.setAmiId("c75daaae");
d.setAvailabilityzone("US-East-1a");
d.setConcurrency(4);

User u=new User();
d.setCreatedby(u);
d.setCreateddate((long) (2010-05-14));
d.setDeleted(true);
d.setDestinationos("Windows");
d.setDestinationversion("v2");
d.setEngine("cosmos.v9");
d.setGroup(g);
d.setId(73);
d.setInstanceType("c1.xlarge");
d.setKeyName("cloud-key");
d.setLastmodifiedby(u);
d.setLastmodifieddate((long) (2010-05-14));
d.setMaxInstances(5);

UserInfo uf=new UserInfo();
uf.setId(172);
uf.set_value("testuser");

d.setOwner(uf);
d.setMinInstances(1);

d.setGroup(2);
DestinationParameter[] dparameter=new DestinationParameter[5];
dparameter[0].setKey("DestinationKey");
dparameter[0].set_value("DestinationKeyValue");
dparameter[0].setSecure(true);

d.setParameters(dparameter);
d.setPlatform(Platform.fromString("WINDOWS"));

d.setQueueLowerThreshold(0);
d.setQueueUpperThreshold(1);
d.setSecurityGroup("default");
d.setSqsQueuePrefix("shuckertestuser-nonscaling");
d.setUserDataTemplateName("userdata.sh");

stub.editDestination(d, "125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7");

 

listDestinations

List the destinations associated with the current user.

Parameters

Name Type Description
firstResults
Integer
0-indexed ordinal of the first record to return
maxResult
Integer
the maximum number of records to return
sessionId
String
sessionId of the current session

Returns

Name Type Description
Destination(0..*)
List <Destination>
a list of Destinations

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:listDestinations>
<!--Optional:-->
<firstResult>0</firstResult>
<!--Optional:-->
<maxResults>100</maxResults>
<!--Optional:-->
<sessionId>125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130</sessionId>
</crud:listDestinations>
</soapenv:Body>
</soapenv:Envelope>  

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:listDestinationsResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return id="73">
<owner id="171">shuckertestuser</owner>
<amiId>ami-c75daaae</amiId>
<availabilityzone>US-East-1a</availabilityzone>
<concurrency>4</concurrency>
<engine>cosmos.v9</engine>
<instanceType>c1.xlarge</instanceType>
<keyName>cloud-key</keyName>
<maxInstances>0</maxInstances>
<minInstances>0</minInstances>
<parameters/>
<queueLowerThreshold>0</queueLowerThreshold>
<queueUpperThreshold>1</queueUpperThreshold>
<securityGroup>default</securityGroup>
<sqsQueuePrefix>shuckertestuser-nonscaling</sqsQueuePrefix>
<userDataTemplateName>userdata.sh</userDataTemplateName>
</return>
<return id="251">
<owner id="171">shuckertestuser</owner>
<amiId>ami-a0d225c9</amiId>
<availabilityzone>US-East-1a</availabilityzone>
<concurrency>4</concurrency>
<engine>cosmos.v10</engine>
<instanceType>m1.large</instanceType>
<keyName>cloud-key</keyName>
<maxInstances>1</maxInstances>
<minInstances>1</minInstances>
<parameters/>
<queueLowerThreshold>0</queueLowerThreshold>
<queueUpperThreshold>1</queueUpperThreshold>
<securityGroup>default</securityGroup>
<sqsQueuePrefix>v10-6ebacc70-12ef-45d4-b18a-c6834a7dac49</sqsQueuePrefix>
<userDataTemplateName>userdata.sh</userDataTemplateName>
      .
      .
      .
</return>
</ns2:listDestinationsResponse>
</S:Body>
</S:Envelope>  

 

Java Code Sample

Method Signature:      public java.util.List<com.pervasive.datasolutions.datacloud.persistence.ent.Destination>                                                        listDestinations(java.lang.Integer firstResults, java.lang.Integer maxResult,                                                                                                                                           java.lang.String sessionId)
                                          throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                          com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:                    

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import java.util.List;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

ArrayList<Destination> list;
list = (ArrayList<Destination>) stub.listDestinations(0, Integer.MAX_VALUE, "125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7");

 

listDestinationsByGroup

List the destinations associated with the group .

Parameters

Name Type Description
firstResults
Integer
0-indexed ordinal of the first record to return
maxResult
Integer
the maximum number of records to return
id
Long
the id of group
sessionId
String
sessionId of the current session

Returns

Name Type Description
Destination(0..*)
List <Destination>
a list of Destinations

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:listDestinationsByGroup>
<!--Optional:-->
<firstResult>0</firstResult>
<!--Optional:-->
<maxResults>1</maxResults>
<!--Optional:-->
<id>2</id>
<!--Optional:-->
<sessionId>560ee69a-c0cd-4f11-9579-4cda37be4220</sessionId>
</crud:listDestinationsByGroup>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>            
<ns2:listDestinationsByGroupResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return id="462">
<owner id="171">shuckertestuser</owner>
<account>1</account>
<amiId>ami-c75daaae</amiId>
<availabilityzone>US-East-1a</availabilityzone>
<concurrency>4</concurrency>
<createdby>171</createdby>
<deleted>false</deleted>
<destinationos>?</destinationos>
<destinationversion>?</destinationversion>
<engine>cosmos.v9</engine>
<group>2</group>
<instanceType>c1.xlarge</instanceType>
<keyName>cloud-key</keyName>
<lastmodifiedby>171</lastmodifiedby>
<maxInstances>0</maxInstances>
<minInstances>0</minInstances>
<parameters>
<parameter key="parameter key test">destination parameter value</parameter>
</parameters>
<platform>LINUX</platform>
<queueLowerThreshold>0</queueLowerThreshold>
<queueUpperThreshold>1</queueUpperThreshold>
<securityGroup>default</securityGroup>
<sqsQueuePrefix>shuckertestuser-nonscaling</sqsQueuePrefix>
<userDataTemplateName>userdata.sh</userDataTemplateName>
</return>
</ns2:listDestinationsByGroupResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:                  List<com.pervasive.datasolutions.datacloud.persistence.ent.Destination>                                                                     listDestinationsByGroup(Integer firstResults, Integer maxResult, Long id,                                                                                                                                                              String sessionId)
                                          throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                          com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:                    

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import java.util.List;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

ArrayList<Destination> list;
list = (ArrayList<Destination>) stub.listDestinationsByGroup(0, Integer.MAX_VALUE, 2,"34f1befe-a322-411f-aa68-e8f10c22c750");

 

deleteDestination

Delete a destination by id

Parameters

Name Type Description
id
Long
the id of the destination to delete
sessionId
String
the sessionId of the current user session

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:deleteDestination>
<!--Optional:-->
<id>257</id>
<!--Optional:-->
<sessionId>125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7</sessionId>
</crud:deleteDestination>
</soapenv:Body>
</soapenv:Envelope>  

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:deleteDestinationResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity"/>
</S:Body>
</S:Envelope> 

 

Java Code Sample

Method Signature:     public void deleteDestination(java.lang.Long id, java.lang.String sessionId)
                                               throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                               com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

stub.deleteDestination(257, "125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7");

 

getDestinationCount

Count the Destinations associated with the current User.

Parameters

Name Type Description
sessionId
String
sessionId of the current session

Returns

Name Type Description
Count Of Destination
Long
count of Destinations

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:getDestinationCount>
<!--Optional:-->
<sessionId>125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130</sessionId>
</crud:getDestinationCount>
</soapenv:Body>
</soapenv:Envelope>  

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getDestinationCountResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>10</return>
</ns2:getDestinationCountResponse>
</S:Body>
</S:Envelope>  

 

Java Code Sample

Method Signature:       public java.lang.Long getDestinationCount(java.lang.String sessionId)
                                            throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                            com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Long DestinationCount=stub.getDestinationCount("125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130");

 

getDestinationParameter

Return the value of a parameter associated with a destination referenced by id

Parameters

Name Type Description
Id
Long
the id of the destination
key
String
key of the parameter to return
sessionId
String
sessionId of the current session

Returns

Name Type Description
Parameter Value
String
the value of the parameter

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:getDestinationParameter>
<!--Optional:-->
<id>73</id>
<!--Optional:-->
<key>destination parameter key</key>
<!--Optional:-->
<sessionId>125003101223.6634.326B.C412.41CD.8643.4190</sessionId>
</crud:getDestinationParameter>
</soapenv:Body/>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>       
<ns2:getDestinationParameterResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>destination parameter value</return>
</ns2:getDestinationParameterResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:      public java.lang.String getDestinationParameter(java.lang.Long id, java.lang. String key,
                                                                                                                                            java.lang.String sessionId)
                                         throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                         com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

String Destinationparameter=stub.getDestinationParameter(73, "parameter key", "125003101223.6634.326B.C412.41CD.8643.4190");

 

putDestinationFile

Upload a file associated with a Destination.

Parameters

Name Type Description
Id
Long
the id of the Destination
filename
String
name of the file to upload
data
DataHandler
DataHandler wrapping the file data
sessionId
String
sessionId of the current session

Returns

Name Type Description
Number Of Bytes
Long
number of bytes written

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:putDestinationFile>
<!--Optional:-->
<destinationId>73</destinationId>
<!--Optional:-->
<filename>destination file</filename>
<!--Optional:-->
<data>cid:585732487039</data>
<!--Optional:-->
<sessionId>125003101223.6634.326B.C412.41CD.8643.4190</sessionId>
</crud:putDestinationFile>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:putDestinationFileResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>9</return>
</ns2:putDestinationFileResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:         public java.lang.Long putDestinationFile(java.lang.Long id, java.lang.String filename,
                                                                                                              javax.activation.DataHandler data,
                                                                                                             java.lang.String sessionId)
                                         throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                         com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:     

import javax.activation.DataHandler;
import javax.activation.DataSource;
import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Long size = 0L;
String where="DestinationFile";
InputStream in= new FileInputStream("InputStreamToFile.txt");
DataSource dataSource = new DataSource() {

@Override
public InputStream getInputStream() throws IOException {
return in;
}

@Override
public OutputStream getOutputStream() throws IOException {
return null;
}

@Override
public String getContentType() {
return "application/octet-stream";
}

@Override
public String getName() {
return where;
}
};
DataHandler dataHandler = new DataHandler(dataSource);
size = stub.putDestinationFile(73, where, dataHandler, "125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7");

 

removeDestinationParameter

Remove a parameter from a Destination.

Parameters

Name Type Description
Id
Long
the id of the Destination from which to remove a parameter
key
String
the key of the parameter
sessionId
String
sessionId of the current session

Returns

Name Type Description
Parameter Value
String
the old value of the parameter

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:removeDestinationParameter>
<!--Optional:-->
<id>73</id>
<!--Optional:-->
<key>parameter key</key>
<!--Optional:-->
<sessionId>125003101223.6634.326B.C412.41CD.8643.4190</sessionId>
</crud:removeDestinationParameter>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:removeDestinationParameterResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>destination parameter value</return>
</ns2:removeDestinationParameterResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:       public java.lang.String removeDestinationParameter(java.lang.Long id,
                                                                                                                              java.lang.String key,
                                                                                                                             java.lang.String sessionId)
                                         throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                         com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:                  

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

String Destinationparameter=stub.removeDestinationParameter(73, "parameter key", "125003101223.6634.326B.C412.41CD.8643.4190");

 

listDestinationFiles

List files associated with a Destination.

Parameters

Name Type Description
Id
Long
the id of the Destination
sessionId
String
sessionId of the current session

Returns

Name Type Description
File Names
List<java.lang.String>
List of filenames associated with the Destination

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:listDestinationFiles>
<!--Optional:-->
<destinationId>73</destinationId>
<!--Optional:-->
<sessionId>125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130</sessionId>
</crud:listDestinationFiles>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:listDestinationFilesResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>destination file</return>
</ns2:listDestinationFilesResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:         public java.util.List<java.lang.String> listDestinationFiles(java.lang.Long id,                                                                                                                                                        java.lang.String sessionId)
                                         throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                         com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import java.util.List;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

List <String> DestinationFiles=stub.listDestinationFiles(73, "125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130");

 

getDestinationFile

Download a file associated with a Destination.

Parameters

Name Type Description
Id
Long
the id of the Destination
filename
String
name of the file to download
sessionId
String
sessionId of the current session

Returns

Name Type Description
Destination File
DataHandler
DataHandler wrapping the file data

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:getDestinationFile>
<!--Optional:-->
<destinationId>73</destinationId>
<!--Optional:-->
<filename>destination file</filename>
<!--Optional:-->
<sessionId>125003101223.6634.326B.C412.41CD.8643.4190</sessionId>
</crud:getDestinationFile>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getDestinationFileResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>cid585732487</return>
</ns2:getDestinationFileResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:        public javax.activation.DataHandler getDestinationFile(java.lang.Long id,                                                                                                                                                          java.lang.String filename,                                                                                                                                        java.lang.String sessionId)
                                         throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                         com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:                

import javax.activation.DataHandler;
import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

DataHandler fileHandlr = null;
fileHandlr = stub.getDestinationFile(73, "destination file", "125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7");

 

putDestinationParameter

Store a key/value pair associated with a destination identified by id

Parameters

Name Type Description
Id
Long
the id of the destination
key
String
the key of the parameter
value
String
the value of the parameter
sessionId
String
sessionId of the current session

Returns

Name Type Description
Parameter Value
String
the old value of the parameter, or null if it is a new parameter

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:putDestinationParameter>
<!--Optional:-->
<id>73</id>
<!--Optional:-->
<key>parameter key</key>
<!--Optional:-->
<value>destination parameter value</value>
<!--Optional:-->
<sessionId>125003101223.6634.326B.C412.41CD.8643.4190</sessionId>
</crud:putDestinationParameter>
</soapenv:Body>
</soapenv:Envelope>



SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:putDestinationParameterResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity"/>
</S:Body>
</S:Envelope>



Java Code Sample

Method Signature:     public java.lang.String putDestinationParameter(java.lang.Long id, java.lang.String key,
                                                                                                                        java.lang.String value,
                                                                                                                       java.lang.String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:                  

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

String Destinationparameter=stub.putDestinationParameter(73, "parameter key", "parameter value", "125003101223.6634.326B.C412.41CD.8643.4190");

 

deleteDestinationFile

Delete a file associated with a Destination.

Parameters

Name Type Description
Id
Long
the id of the Destination
filename
String
name of the file to delete
sessionId
String
sessionId of the current session

Returns

Name Type Description
Number Of Bytes
Long
number of bytes deleted

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:deleteDestinationFile>
<!--Optional:-->
<destinationId>73</destinationId>
<!--Optional:-->
<filename>destination file</filename>
<!--Optional:-->
<sessionId>125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7</sessionId>
</crud:deleteDestinationFile>
</soapenv:Body>
</soapenv:Envelope> 

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:deleteDestinationFileResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>10</return>
</ns2:deleteDestinationFileResponse>
</S:Body>
</S:Envelope> 

 

Java Code Sample

Method Signature:       public java.lang.Long deleteDestinationFile(java.lang.Long id,                                                                                                                                                        java.lang.String filename,                                                                                                                                             java.lang.String sessionId)
                                               throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.da&nbsp;tasolutions.datacloud.exceptions.CloudAPIException

 

Usage:

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Long bytesdeleted=stub.deleteDestinationFile(73, "destination file", "125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7");

 

createUser

Creates a user object. This method exists only for completeness and does nothing.

Parameters

Name Type Description
user
User
the user object to create
sessionId
String
the sessionId associated with the currently logged in user

Returns

Name Type Description
User
User
the new user created

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:createUser>
<!--Optional:-->
<user id="178">
<!--Optional:-->
<owner id="171">shuckertestuser</owner>
<!--Optional:-->
<account>100</account>
<!--Optional:-->
<active>true</active>
<!--Optional:-->
<administrator>0</administrator>
<!--Optional:-->
<createdby>171</createdby>
<!--Optional:-->
<createddate>2011-11-02T00:00:00-04:00</createddate>
<!--Optional:-->
<deleted>false</deleted>
<!--Optional:-->
<group>163</group>
<!--Optional:-->
<lastmodifiedby>171</lastmodifiedby>
<!--Optional:-->
<lastmodifieddate>2011-11-01T00:00:00-04:00</lastmodifieddate>
<!--Optional:-->
<name>newUser</name>
<!--Optional:-->
<parameters>
<!--Zero or more repetitions:-->
<parameter key="myUserKey" secure="no">myUserValue</parameter>
</parameters>
<!--Optional:-->
<passwordexpiration>2012-10-24T00:00:00-04:00</passwordexpiration>
<!--Optional:-->
<temporarypassword>temp</temporarypassword>
</user>
<!--Optional:-->
<sessionId>82f379ab-44e4-4d04-b0da-7c11404cfd99</sessionId>
</crud:createUser>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:Fault xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns3="http://www.w3.org/2003/05/soap-envelope">
<faultcode>ns2:Server</faultcode>
<faultstring>Not supported yet.</faultstring>
</ns2:Fault>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:         public com.pervasive.datasolutions.datacloud.persistence.ent.User                                                                                          createUser(com.pervasive.datasolutions.datacloud.persistence.ent.User user,
                                                                                                                                                           String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:              

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

User u=new User();
UserInfo uf=new UserInfo();
uf.setId(172);
uf.set_value("testuser");

u.setGroup(2);

u.setAccount((long) 1001);
u.setActive(true);
u.setAdministrator(true);
u.setCreateddate((long) (2010-05-14));
u.setDeleted(false);
u.setId(12056);
u.setLastmodifiedby(u);
u.setLastmodifieddate((long) (2010-05-14));
u.setName("testuser");
u.setOwner(uf);
u.setPasswordexpiration((long) 109);
u.setTemporarypassword(true);


UserParameter[] parameter=new UserParameter[5];
parameter[0].setKey("ProductKey");
parameter[0].set_value("ProductValue");
parameter[0].setSecure(true);


u.setParameters(parameter);
u.setCreatedby(u);

User newuser=stub.createUser(u, "125003101227.4253.DC58.5A73.4AC1.AED2.5687");

 

findUser

Return a user by id, must be the logged in user.

Parameters

Name Type Description
id
Long
id of the user to return
sessionId
String
sessionId of the current session

Returns

Name Type Description
User
User
the user

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:findUser>
<!--Optional:-->
<id>171</id>
<!--Optional:-->
<sessionId>125003101223.6634.326B.C412.41CD.8643.4190</sessionId>
</crud:findUser>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findUserResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return id="171">
<name>shuckertestuser</name>
<parameters>
<parameter key="membership.company">Shucker Testing</parameter>
<parameter key="membership.firstname">Test</parameter>
<parameter key="awsSecretKey">9jY7cT605V4R3vdWJb3Ra+XbVXLwi7fYzum4fxKa</parameter>
<parameter key="membership.email">shuckertesting@pervasive.com</parameter>
<parameter key="membership.lastname">User</parameter>
<parameter key="key">value</parameter>
<parameter key="membership.phone">123-456-7890</parameter>
<parameter key="awsAccessKey">AKIAIGM4XXTMW3BYABPA</parameter>
</parameters>
</return>
</ns2:findUserResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:         public com.pervasive.datasolutions.datacloud.persistence.ent.User findUser                                                                                           (java.lang.Long id, java.lang.String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:      

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;


EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

User user = stub.findUser(171, "125003101223.6634.326B.C412.41CD.8643.4190");

 

editUser

Edit the user associated with the user. At this point only parameters associated with the user can be modified.

Parameters

Name Type Description
user
User
the new value of the user object
sessionId
String
sessionId of the current session

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:editUser>
<!--Optional:-->
<user id="1362">
<!--Optional:-->
<owner id="171">shuckertestuser</owner>
<!--Optional:-->
<account>100</account>
<!--Optional:-->
<active>false</active>
<!--Optional:-->
<administrator>false</administrator>
<!--Optional:-->
<createdby>171</createdby>
<!--Optional:-->
<createddate>2011-11-02T00:00:00-04:00</createddate>
<!--Optional:-->
<deleted>false</deleted>
<!--Optional:-->
<group>163</group>
<!--Optional:-->
<lastmodifiedby>171</lastmodifiedby>
<!--Optional:-->
<lastmodifieddate>2011-11-01T00:00:00-04:00</lastmodifieddate>
<!--Optional:-->
<name>ds.test</name>
<!--Optional:-->
<parameters>
<!--Zero or more repetitions:-->
<parameter key="myuserKey" secure="no">myUSerValue</parameter>
</parameters>
<!--Optional:-->
<passwordexpiration>2012-11-01T00:00:00-04:00</passwordexpiration>
<!--Optional:-->
<temporarypassword>temp</temporarypassword>
</user>
<!--Optional:-->
<sessionId>82f379ab-44e4-4d04-b0da-7c11404cfd99</sessionId>
</crud:editUser>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:editUserResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity"/>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:         public void editUser
                                                                        (com.pervasive.datasolutions.datacloud.persistence.ent.User user,
                                                                                                                                                        String sessionId)
                                                throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                                com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:                  

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

User u=new User();
UserInfo uf=new UserInfo();
uf.setId(172);
uf.set_value("testuser");

u.setAccount((long) 1001);
u.setActive(true);
u.setAdministrator(true);
u.setCreateddate((long) (2010-05-14));
u.setDeleted(false);
u.setId(12056);
u.setLastmodifiedby(u);
u.setLastmodifieddate((long) (2010-05-14));
u.setName("testuser");
u.setOwner(uf);
u.setPasswordexpiration((long) 109);
u.setTemporarypassword(true);

u.setGroup(2);

UserParameter[] parameter=new UserParameter[5];
parameter[0].setKey("ProductKey");
parameter[0].set_value("ProductValue");
parameter[0].setSecure(true);


u.setParameters(parameter);
u.setCreatedby(u);

stub.editUser(u, "125003101227.4253.DC58.5A73.4AC1.AED2.5687");

 

listUsers

List the users associated with the current user (always returns a one-item list).

Parameters

Name Type Description
firstResults
Integer
0-indexed ordinal of the first record to return
maxResult
Integer
the maximum number of records to return
sessionId
String
sessionId of the current session

Returns

Name Type Description
User(0..*)
List<User>
a list of Users

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:listUsers>
<!--Optional:-->
<firstResult>0</firstResult>
<!--Optional:-->
<maxResults>100</maxResults>
<!--Optional:-->
<sessionId>125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130</sessionId>
</crud:listUsers>
</soapenv:Body>
</soapenv:Envelope>  

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:listUsersResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return id="171">
<name>shuckertestuser</name>
<parameters>
<parameter key="membership.company">Shucker Testing</parameter>
<parameter key="membership.firstname">Test</parameter>
<parameter key="awsAccessKey">AKIAIGM4XXTMW3BYABPA</parameter>
</parameters>
</return>
      .
      .
      .
</ns2:listUsersResponse>
</S:Body>
</S:Envelope>  

 

Java Code Sample

Method Sidgnature:       public java.util.List<com.pervasive.datasolutions.datacloud.persistence.ent.User>
                                                                                                        listUsers (java.lang.Integer firstResults,
                                                                                                        java.lang.Integer maxResult,
                                                                                                       java.lang.String sessionId)
                                             throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:              

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import java.util.List;


EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

List<User> userList = stub.listUsers(0, 25, "125003101223.6634.326B.C412.41CD.8643.4190");

 

listUsersByGroup

List the users that have access to the group.

Parameters

Name Type Description
firstResults
Integer
0-indexed ordinal of the first record to return
maxResult
Integer
the maximum number of records to return
id
Long
the group id
sessionId
String
sessionId of the current session

Returns

Name Type Description
User(0..*)
List<User>
a list of Users

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:listUsersByGroup>
<!--Optional:-->
<firstResult>0</firstResult>
<!--Optional:-->
<maxResults>10</maxResults>
<!--Optional:-->
<id>163</id>
<!--Optional:-->
<sessionId>82f379ab-44e4-4d04-b0da-7c11404cfd99</sessionId>
</crud:listUsersByGroup>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:listUsersByGroupResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity"/>
</S:Body>
</S:Envelope>

 

Java Code Sample
Method Sidgnature:       List<com.pervasive.datasolutions.datacloud.persistence.ent.User> listUsersByGroup                                                              (Integer firstResults,Integer maxResult, Long id, String sessionId)
                                             throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                             com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:              

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import java.util.List;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

List<User> userList = stub.listUsersByGroup(0, 10, 2, "34f1befe-a322-411f-aa68-e8f10c22c750");

 

deleteUser

Delete a user by id. This is presented for completeness and does nothing.

Parameters

Name Type Description
id
Long
id of the user to delete
sessionId
String
sessionId of the current session

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:deleteUser>
<!--Optional:-->
<id>1362</id>
<!--Optional:-->
<sessionId>30fa4f5a-f67c-4ea0-a6a7-60f2e2c3f9c3</sessionId>
</crud:deleteUser>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:Fault xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns3="http://www.w3.org/2003/05/soap-envelope">
<faultcode>ns2:Server</faultcode>
<faultstring>User may not delete self</faultstring>
</ns2:Fault>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:         public void deleteUser(java.lang.Long id, java.lang.String sessionId)
                                                 throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                                 com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:           

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

stub.deleteUser(171, "125003101223.6634.326B.C412.41CD.8643.4190");

 

getUserCount

Count the users associated with the current user. Should generally return 1.

Parameters

Name Type Description
sessionId
String
sessionId of the current session

Returns

Name Type Description
User Count
Long
count of Users

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:getUserCount>
<!--Optional:-->
<sessionId>125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130</sessionId>
</crud:getUserCount>
</soapenv:Body>
</soapenv:Envelope>  

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getUserCountResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>1</return>
</ns2:getUserCountResponse>
</S:Body>
</S:Envelope>  

 

Java Code Sample

Method Sidgnature:        public java.lang.Long getUserCount(java.lang.String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:    

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Long UserCount=stub.getUserCount("125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130");

 

getUserParameter

Return the value of a parameter associated with a user referenced by id.

Parameters

Name Type Description
id
Long
the id of the User
key
String
the key of the parameter to return
sessionId
String
sessionId of the current session

Returns

Name Type Description
Parameter Value
String
the value of the parameter

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http:/
/schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:getUserParameter>
<!--Optional:-->
<id>171</id>
<!--Optional:-->
<key>User parameter key</key>
<!--Optional:-->
<sessionId>125003101223.6634.326B.C412.41CD.8643.4190</sessionId>
</crud:getUserParameter>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getUserParameterResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>User parameter value</return>
</ns2:getUserParameterResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:       public java.lang.String getUserParameter(java.lang.Long id,                                                                                                                                             java.lang.String key,
                                                                                                            java.lang.String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:           

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();
String UserParameter=stub.getUserParameter(171, "parameterkey", "125003101223.6634.326B.C412.41CD.8643.4190");

 

putUserParameter

Store a key/value pair associated with a user identified by id.

Parameters

Name Type Description
id
Long
the id of the User
key
String
the key of the parameter
value
String
the value of the parameter
sessionId
String
sessionId of the current session

Returns

Name Type Description
Parameter Value
String
the old value of the parameter, or null if it is a new parameter

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:putUserParameter>
<!--Optional:-->
<id>171</id>
<!--Optional:-->
<key>userkey</key>
<!--Optional:-->
<value>uservalue</value>
<!--Optional:-->
<sessionId>125003101223.6634.326B.C412.41CD.8643.4190</sessionId>
</crud:putUserParameter>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:putUserParameterResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity"/>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:       public java.lang.String putUserParameter(java.lang.Long id,                                                                                                                                             java.lang.String key,
                                                                                                            java.lang.String value,
                                                                                                           java.lang.String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:      

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

String UserParameter=stub.putUserParameter(171, "awsAccessKey", "awsAccessvalue", "125003101227.4253.DC58.5A73.4AC1.AED2.5687");

 

removeUserParameter

Remove a parameter from a User.

Parameters

Name Type Description
id
Long
the id of the User from which to remove a parameter
key
String
the key of the parameter
sessionId
String
sessionId of the current session

Returns

Name Type Description
Parameter Value
String
the old value of the parameter

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:removeUserParameter>
<!--Optional:-->
<id>171</id>
<!--Optional:-->
<key>userkey</key>
<!--Optional:-->
<sessionId>125003101227.4253.DC58.5A73.4AC1.AED2.5687</sessionId>
</crud:removeUserParameter>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:removeUserParameterResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>uservalue</return>
</ns2:removeUserParameterResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:        public java.lang.String removeUserParameter(java.lang.Long id,
                                                                                                                     java.lang.String key,
                                                                                                                     java.lang.String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:      

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

String ParameterValue=stub.removeUserParameter(171, "userkey", "125003101227.4253.DC58.5A73.4AC1.AED2.5687");

 

listUserFiles

List files associated with a user.

Parameters

Name Type Description
id
Long
id of the User
sessionId
String
sessionId of the current session

Returns

Name Type Description
File Names
List<java.lang.String>
list of filenames available for download

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:listUserFiles>
<!--Optional:-->
<userId>171</userId>
<!--Optional:-->
<sessionId>125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA</sessionId>
</crud:listUserFiles>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:listUserFilesResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>testfile</return>
</ns2:listUserFilesResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:        public java.util.List<java.lang.String> listUserFiles(java.lang.Long id,
                                                                                                                               java.lang.String sessionId)
                                                 throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                                 com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException
                                             

Usage:     

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import java.util.List;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

List<String> Filelist=stub.listUserFiles(171, "125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA");

 

getUserFile

Download a file associated with a User.

Parameters

Name Type Description
id
Long
id of the User
filename
String
filename to download
sessionId
String
sessionId of the current session

Returns

Name Type Description
User File
DataHandler
DataHandler wrapping the file

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:getUserFile>
<!--Optional:-->
<userId>171</userId>
<!--Optional:-->
<filename>testfile</filename>
<!--Optional:-->
<sessionId>125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA</sessionId>
</crud:getUserFile>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getUserFileResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>cid1077498020307</return>
</ns2:getUserFileResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:         public javax.activation.DataHandler getUserFile(java.lang.Long id,
                                                                                                                           java.lang.String filename,
                                                                                                                          java.lang.String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:          

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import javax.activation.DataHandler

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

DataHandler fileHandlr = null;
fileHandlr = stub.getUserFile(171, "testfile", "125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA");


 

putUserFile

Upload a file associated with a User.

Parameters

Name Type Description
id
Long
id of the user
filename
String
name of the file being uploaded
data
String
DataHandler wrapping the file to upload
sessionId
String
sessionId of the current session

Returns

Name Type Description
Number Of Bytes
Long
the number of bytes uploaded

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:putUserFile>
<!--Optional:-->
<userId>171</userId>
<!--Optional:-->
<filename>test</filename>
<!--Optional:-->
<data>cid:173999292590</data>
<!--Optional:-->
<sessionId>125003101223.6634.326B.C412.41CD.8643.4190</sessionId>
</crud:putUserFile>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:putUserFileResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>9</return>
</ns2:putUserFileResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:         public java.lang.Long putUserFile(java.lang.Long id,                                                                                                                                  java.lang.String filename,
                                                                                                   javax.activation.DataHandler data,
                                                                                                  java.lang.String sessionId)                                                                                    throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                               com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:         

import javax.activation.DataHandler;
import javax.activation.DataSource;
import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();
Long size = 0L;
String where="UserFile";
InputStream in= new FileInputStream("InputStreamToFile.txt");
DataSource dataSource = new DataSource() {

@Override
public InputStream getInputStream() throws IOException {
return in;
}

@Override
public OutputStream getOutputStream() throws IOException {
return null;
}

@Override
public String getContentType() {
return "application/octet-stream";
}

@Override
public String getName() {
return where;
}
};
DataHandler dataHandler = new DataHandler(dataSource);

size = stub.putUserFile(171, where, dataHandler, "125003101223.6634.326B.C412.41CD.8643.4190");

 

deleteUserFile

Delete a file associated with a User.

Parameters

Name Type Description
id
Long
id of the User
filename
String
filename to delete
sessionId
String
sessionId of the current session

Returns

Name Type Description
Nuber Of Bytes
Long
number of bytes deleted

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:deleteUserFile>
<!--Optional:-->
<userId>171</userId>
<!--Optional:-->
<filename>testfile</filename>
<!--Optional:-->
<sessionId>125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA</sessionId>
</crud:deleteUserFile>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:deleteUserFileResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>10</return>
</ns2:deleteUserFileResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:        public java.lang.Long deleteUserFile(java.lang.Long id,                                                                                                                                      java.lang.String filename,
                                                                                                     java.lang.String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:          

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Long deletedbytes=stub.deleteUserFile(171,"testfile", "125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA");

 

createExecution

Create an execution object in preparation for job execution.

Parameters

Name Type Description
execution
Execution
the execution to create
provisioningId
Long
the unique id of the provisioning which will be executed
sessionId
String
the sessionId of the current user

Returns

Name Type Description
Execution
Execution
the newly persisted execution object

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:createExecution>
<!--Optional:-->
<execution id="40">
<!--Optional:-->
<owner id="171">shuckertestuser</owner>
<!--Optional:-->
<account>100</account>
<!--Optional:-->
<currentTime>2011-11-1</currentTime>
<!--Optional:-->
<finishTime>2011-1-1</finishTime>
<!--Optional:-->
<group>2</group>
<!--Optional:-->
<logFile>fd.log</logFile>
<!--Optional:-->
<parameters>
<!--Zero or more repetitions:-->
<parameter key="key1" secure="no">value1</parameter>
</parameters>
<!--Optional:-->
<provisioning>testprovisionig</provisioning>
<!--Optional:-->
<returncode>0</returncode>
<!--Optional:-->
<scheduledTime>0</scheduledTime>
<!--Optional:-->
<server>b71cf2d8-a5e8-4563-89a7-4bacdcc9c72f</server>
<!--Optional:-->
<startTime>2011-11-1</startTime>
<!--Optional:-->
<state>active</state>
</execution>
<!--Optional:-->
<provisioningId>12624</provisioningId>
<!--Optional:-->
<sessionId>6b1b4e5e-6a9a-43f0-8e19-3e569efa0dec</sessionId>
</crud:createExecution>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:createExecutionResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return id="40">
<owner id="171">shuckertestuser</owner>
<account>1</account>
<currentTime>2011-11-01T12:24:00.535Z</currentTime>
<logFile>fd.log</logFile>
<parameters>
<parameter key="key1">value1</parameter>
</parameters>
<provisioning>12624</provisioning>
<returncode>0</returncode>
<scheduledTime>2011-11-01T12:24:00.503Z</scheduledTime>
<server>b71cf2d8-a5e8-4563-89a7-4bacdcc9c72f</server>
<state>active</state>
</return>
</ns2:createExecutionResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:   public com.pervasive.datasolutions.datacloud.persistence.ent.Execution createExecution
                                                            (com.pervasive.datasolutions.datacloud.persistence.ent.Execution execution,
                                                                                                                                    Long provisioningId,
                                                                                                                                           String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:                 


import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import java.text.SimpleDateFormat;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Execution e =new Execution();

Calendar currentTime=Calendar.getInstance();
Calendar finishTime=Calendar.getInstance();

e.setCurrentTime(currentTime);
e.setFinishTime(finishTime);
e.setId("101");
e.setLogFile("ExecutionLog.log");

e.setGroup(2);

ExecutionParameter[] eparameter=new ExecutionParameter[5];
eparameter[0].setKey("Executionkey");
eparameter[0].set_value("ExecutionkeyValue");
eparameter[0].setSecure(true);

e.setParameters(eparameter);

UserInfo uf=new UserInfo();
uf.setId(172);
uf.set_value("testuser");

e.setOwner(uf);
e.setProvisioning((long) 13172);
e.setReturncode("0");

Calendar scheduledTime=Calendar.getInstance();

Calendar startTime=Calendar.getInstance();
Calendar startTi,me=Calendar.getInstance();

e.setScheduledTime(scheduledTime);
e.setServer("domU-12-31-39-0B-2A-41.compute-1.internal");
e.setStartTime(startTime);
e.setState("active");
e.setZkNode("zknod");

Execution e = stub.createExecution(execution, 12086, "125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA");

 

findExecution

Return an execution by id.

Parameters

Name Type Description
id
String
id of the execution to return
sessionId
String
sessionId of the current session

Returns

Name Type Description
Execution
Execution
the execution

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:findExecution>
<!--Optional:-->
<id>3dc247c2-1abb-47be-a698-788bf37339e4</id>
<!--Optional:-->
<sessionId>125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA</sessionId>
</crud:findExecution>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findExecutionResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return id="3dc247c2-1abb-47be-a698-788bf37339e4">
<owner id="171">shuckertestuser</owner>
<finishTime>2011-06-30T00:00:00-04:00</finishTime>
<logFile>executionlogfile_test</logFile>
<parameters>
<parameter key="testparameter">testparametervalue</parameter>
</parameters>
<scheduledTime>2010-05-14T00:00:00-04:00</scheduledTime>
<server>domU-12-31-39-0B-2A-41.compute-1.internal</server>
<startTime>2010-05-14T00:00:00-04:00</startTime>
</return>
</ns2:findExecutionResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:        public com.pervasive.datasolutions.datacloud.persistence.ent.Execution findExecution
                                                                                                                             (java.lang.String id,                                                                                                                               java.lang.String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:      

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Execution e = stub.findExecution("3dc247c2-1abb-47be-a698-788bf37339e4", "125003101229.F1BE.46B1.1DA3.4544.A25F.69E8");

 

editExecution

Edit an execution object that has not yet been started.

Parameters

Name Type Description
execution
Execution
the new value of the execution object
sessionId
String
sessionId of the current session

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:editExecution>
<!--Optional:-->
<execution id="40">
<!--Optional:-->
<owner id="171">shuckertestuser</owner>
<!--Optional:-->
<account>100</account>
<!--Optional:-->
<currentTime>2011-11-1</currentTime>
<!--Optional:-->
<finishTime>2011-1-1</finishTime>
<!--Optional:-->
<group>2</group>
<!--Optional:-->
<logFile>fd.log</logFile>
<!--Optional:-->
<parameters>
<!--Zero or more repetitions:-->
<parameter key="myExecParamKey" secure="no">myExecParamValue</parameter>
</parameters>
<!--Optional:-->
<provisioning>testprovisionig</provisioning>
<!--Optional:-->
<returncode>0</returncode>
<!--Optional:-->
<scheduledTime>0</scheduledTime>
<!--Optional:-->
<server>b71cf2d8-a5e8-4563-89a7-4bacdcc9c72f</server>
<!--Optional:-->
<startTime>2011-11-1</startTime>
<!--Optional:-->
<state>active</state>
</execution>
<!--Optional:-->
<sessionId>82f379ab-44e4-4d04-b0da-7c11404cfd99</sessionId>
</crud:editExecution>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:editExecutionResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity"/>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:  public void editExecution
                                                  (com.pervasive.datasolutions.datacloud.persistence.ent.Execution execution,
                                                                                                                                  java.lang.String sessionId)
                                            throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,                                             com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:                 

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Execution e =new Execution();

Calendar currentTime=Calendar.getInstance();
Calendar finishTime=Calendar.getInstance();

e.setCurrentTime(currentTime);
e.setFinishTime(finishTime);
e.setId("101");
e.setLogFile("ExecutionLog.log");

e.setGroup(2);

ExecutionParameter[] eparameter=new ExecutionParameter[5];
eparameter[0].setKey("Executionkey");
eparameter[0].set_value("ExecutionkeyValue");
eparameter[0].setSecure(true);

e.setParameters(eparameter);

UserInfo uf=new UserInfo();
uf.setId(172);
uf.set_value("testuser");

e.setOwner(uf);
e.setProvisioning((long) 13172);
e.setReturncode("0");

Calendar scheduledTime=Calendar.getInstance();

Calendar startTime=Calendar.getInstance();
Calendar startTi,me=Calendar.getInstance();

e.setScheduledTime(scheduledTime);
e.setServer("domU-12-31-39-0B-2A-41.compute-1.internal");
e.setStartTime(startTime);
e.setState("active");
e.setZkNode("zknod");


stub.editExecution(execution, "125003110103.42D1.3564.C437.4893.9EEB.686A");

 

listExecutions

List the executions associated with the current user and specified provisioning.

Parameters

Name Type Description
firstResults
Integer
0-indexed ordinal of the first record to return
maxResult
Integer
the maximum number of records to return
provisioningId
Long
the unique id of the provisioning
sessionId
String
sessionId of the current session

Returns

Name Type Description
Execution(0..*)
List<Execution>
a list of executions

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:listExecutions>
<!--Optional:-->
<firstResult>0</firstResult>
<!--Optional:-->
<maxResults>110</maxResults>
<!--Optional:-->
<provisioningId>13172</provisioningId>
<!--Optional:-->
<sessionId>125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA</sessionId>
</crud:listExecutions>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:listExecutionsResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return id="99abc2c6-bd8e-4559-b23e-5a3fd1fd8ebb">
<owner id="171">shuckertestuser</owner>
<finishTime>2010-12-01T11:12:18.906-05:00</finishTime>
<logFile>provisioning/13172/log/99abc2c6-bd8e-4559-b23e-5a3fd1fd8ebb</logFile>
<parameters>
<parameter key="pathInfo">GetProducts</parameter>
<parameter key="rundate"/>
<parameter key="sessionID">125003101201.5CED.3CBB.B74A.46D1.976F.C27D</parameter>
<parameter key="ipp.realmID">183431896</parameter>
</parameters>
<scheduledTime>2010-12-01T11:12:10.746-05:00</scheduledTime>
<server>domU-12-31-39-0B-2A-41.compute-1.internal</server>
<startTime>2010-12-01T11:12:10.860-05:00</startTime>
</return>
<return id="88bac02f-b89c-4f1e-addf-2f3e6c5c3b14">
<owner id="171">shuckertestuser</owner>
<finishTime>2010-12-01T10:51:04.899-05:00</finishTime>
<logFile>provisioning/13172/log/88bac02f-b89c-4f1e-addf-2f3e6c5c3b14</logFile>
<parameters>
<parameter key="pathInfo">GetProducts</parameter>
<parameter key="rundate"/>
<parameter key="sessionID">125003101201.5CED.3CBB.B74A.46D1.976F.C27D</parameter>
<parameter key="ipp.realmID">183431896</parameter>
</parameters>
<scheduledTime>2010-12-01T10:50:55.408-05:00</scheduledTime>
<server>domU-12-31-39-0B-2A-41.compute-1.internal</server>
<startTime>2010-12-01T10:50:55.401-05:00</startTime>
</return>
      .
      .
      .
</ns2:listExecutionsResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:       public java.util.List<com.pervasive.datasolutions.datacloud.persistence.ent.Execution>
                                                                                                       listExecutions(java.lang.Integer firstResults,
                                                                                                       java.lang.Integer maxResult,
                                                                                                      java.lang.Long provisioningId,
                                                                                                     java.lang.String sessionId)
                                             throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                             com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:                 

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import java.util.List;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

List<Execution> exec = stub.listExecutions(0, 100, 13172, "125003101229.F1BE.46B1.1DA3.4544.A25F.69E8");

 

listExecutionsByGroup

List the executions associated with the group .

Parameters

Name Type Description
firstResults
Integer
0-indexed ordinal of the first record to return
maxResult
Integer
the maximum number of records to return
Id
Long
the group id
sessionId
String
sessionId of the current session

Returns

Name Type Description
Execution(0..*)
List<Execution>
a list of executions

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:listExecutionsByGroup>
<!--Optional:-->
<firstResult>0</firstResult>
<!--Optional:-->
<maxResults>10</maxResults>
<!--Optional:-->
<id>2</id>
<!--Optional:-->
<sessionId>82f379ab-44e4-4d04-b0da-7c11404cfd99</sessionId>
</crud:listExecutionsByGroup>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:listExecutionsByGroupResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity"/>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:      List<com.pervasive.datasolutions.datacloud.persistence.ent.Execution>
                                                                                                       listExecutionsByGroup(Integer firstResults,
                                                                                                       Integer maxResult,
                                                                                                      Long id,
                                                                                                     String sessionId)
                                             throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                             com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:                 

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import java.util.List;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

List<Execution> exec = stub.listExecutionsByGroup(0, 10, 2, "34f1befe-a322-411f-aa68-e8f10c22c750");

 

deleteExecution

Delete an execution by id. Executions can only be deleted if they have not yet been started.

Parameters

Name Type Description
id
String
id of the execution to delete
sessionId
String
sessionId of the current session

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:deleteExecution>
<!--Optional:-->
<id>3dc247c2-1abb-47be-a698-788bf37339e4</id>
<!--Optional:-->
<sessionId>125003101227.4253.DC58.5A73.4AC1.AED2.5687</sessionId>
</crud:deleteExecution>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:deleteExecutionResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity"/>
</S:Body>
</S:Envelope>  

 

Java Code Sample

Method Sidgnature:         public void deleteExecution(java.lang.String id,java.lang.String sessionId)
                                                 throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                                 com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:            

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

stub.deleteExecution("3dc247c2-1abb-47be-a698-788bf37339e4", "125003101227.4253.DC58.5A73.4AC1.AED2.5687");

 

getExecutionCount

Count the Executions associated with the current User and specified Provisioning.

Parameters

Name Type Description
provisioningId
Long
the id of the Provisioning
sessionId
String
sessionId of the current session

Returns

Name Type Description
Execution Count
Long
count of Executions

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:getExecutionCount>
<!--Optional:-->
<provisioningId>12086</provisioningId>
<!--Optional:-->
<sessionId>125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130</sessionId>
</crud:getExecutionCount>
</soapenv:Body>
</soapenv:Envelope>  

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getExecutionCountResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>5</return>
</ns2:getExecutionCountResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:       public java.lang.Long getExecutionCount(java.lang.Long provisioningId,
                                                                                                              java.lang.String sessionId)
 
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:         

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Long ExecutionCount=stub.getExecutionCount(12086, "125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130");

 

getExecutionParameter

Return the value of a parameter associated with an Execution referenced by id.

Parameters

Name Type Description
id
String
the id of the execution
key
String
the key of the parameter to return
sessionId
String
sessionId of the current session

Returns

Name Type Description
Parameter Value
String
the value of the parameter

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:getExecutionParameter>
<!--Optional:-->
<id>3dc247c2-1abb-47be-a698-788bf37339e4</id>
<!--Optional:-->
<key>Execution Parameter Key</key>
<!--Optional:-->
<sessionId>125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA</sessionId>
</crud:getExecutionParameter>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getExecutionParameterResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>Execution Parameter Value</return>
</ns2:getExecutionParameterResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:      public java.lang.String getExecutionParameter(java.lang.String id,
                                                                                                                      java.lang.String key,
                                                                                                                     java.lang.String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:          

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

String ExecutionParameter=stub.getExecutionParameter("3dc247c2-1abb-47be-a698-788bf37339e4", "ExecutionParameterTestKey", "125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA");

 

putExecutionParameter

Store a key/value pair associated with an Execution identified by id.

Parameters

Name Type Description
id
String
id of the Execution
key
String
the key of the parameter
value
String
the value of the parameter
sessionId
String
sessionId of the current session

Returns

Name Type Description
Parameter Value
String
the old value of the parameter, or null if it is a new parameter

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:putExecutionParameter>
<!--Optional:-->
<id>3dc247c2-1abb-47be-a698-788bf37339e4</id>
<!--Optional:-->
<key>Execution Parameter Key</key>
<!--Optional:-->
<value>Execution Parameter Value</value>
<!--Optional:-->
<sessionId>125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA</sessionId>
</crud:putExecutionParameter>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:putExecutionParameterResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity"/>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:       public java.lang.String putExecutionParameter(java.lang.String id,
                                                                                                                       java.lang.String key,
                                                                                                                       java.lang.String value,
                                                                                                                       java.lang.String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:           

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

String ExecutionParameter=stub.putExecutionParameter("3dc247c2-1abb-47be-a698-788bf37339e4", "ExecutionParameterTestKey", "ExecutionParameterTestValue", "125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA");

 

removeExecutionParameter

Remove a parameter from a Execution

Parameters

Name Type Description
id
String
the id of the Execution from which to remove a parameter
key
String
the key of the parameter
sessionId
String
sessionId of the current session

Returns

Name Type Description
Parameter Value
String
the old value of the parameter

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:removeExecutionParameter>
<!--Optional:-->
<id>3dc247c2-1abb-47be-a698-788bf37339e4</id>
<!--Optional:-->
<key>Execution Parameter Key</key>
<!--Optional:-->
<sessionId>125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA</sessionId>
</crud:removeExecutionParameter>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:removeExecutionParameterResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>Execution Parameter Value</return>
</ns2:removeExecutionParameterResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:        public java.lang.String removeExecutionParameter(java.lang.String id,
                                                                                                                              java.lang.String key,
                                                                                                                              java.lang.String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:                

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

String ExecutionParameter=stub.removeExecutionParameter("3dc247c2-1abb-47be-a698-788bf37339e4", "ExecutionParameterTestKey", "125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA");

 

listExecutionFiles

List files associated with an Execution.

Parameters

Name Type Description
id
String
id of the Execution
sessionId
String
sessionId of the current session

Returns

Name Type Description
File Names
List<java.lang.String>
List of file names associated with the Execution

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:listExecutionFiles>
<!--Optional:-->
<executionId>3dc247c2-1abb-47be-a698-788bf37339e4</executionId>
<!--Optional:-->
<sessionId>125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA</sessionId>
</crud:listExecutionFiles>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:listExecutionFilesResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>TestExecutionFile</return>
<return>TestExecutionFile1</return>
</ns2:listExecutionFilesResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:        public java.util.List<java.lang.String> listExecutionFiles(java.lang.String id,
                                                                                                                                         java.lang.String sessionId)
                                                 throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                                 com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException
                                             

Usage:      

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

import java.util.List;
EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

List <String> ExecutionFiles=stub.listExecutionFiles("3dc247c2-1abb-47be-a698-788bf37339e4", "125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA");

 

getExecutionFile

Download a file associated with an Execution.

Parameters

Name Type Description
id
String
id of the Execution
filename
String
name of the file to Download
sessionId
String
sessionId of the current session

Returns

Name Type Description
Execution File
DataHandler
DataHandler associated with the file data

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:getExecutionFile>
<!--Optional:-->
<executionId>3dc247c2-1abb-47be-a698-788bf37339e4</executionId>
<!--Optional:-->
<filename>TestExecutionFile</filename>
<!--Optional:-->
<sessionId>125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA</sessionId>
</crud:getExecutionFile>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getExecutionFileResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>cid630100221</return>
</ns2:getExecutionFileResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:        public javax.activation.DataHandler getExecutionFile(java.lang.String id,
                                                                                                                                    java.lang.String filename,
                                                                                                                                    java.lang.String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:            

import com.pervasive.datasolutions.api.entity.*;import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import javax.activation.DataHandler;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();
DataHandler fileHandlr = null;
fileHandlr = stub.getExecutionFile("3dc247c2-1abb-47be-a698-788bf37339e4", "TestExecutionFile", "125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA");

 

putExecutionFile

Upload a file associated with an Execution.

Parameters

Name Type Description
id
String
id of the Execution
filename
String
name of the file to upload
data
DataHandler
DataHandler associated with the file data
sessionId
String
sessionId of the current session

Returns

Name Type Description
Number Of Bytes
Long
the number of bytes written

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:putExecutionFile>
<!--Optional:-->
<executionId>3dc247c2-1abb-47be-a698-788bf37339e4</executionId>
<!--Optional:-->
<filename>TestExecutionFile</filename>
<!--Optional:-->
<data>cid:630100221060</data>
<!--Optional:-->
<sessionId>125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA</sessionId>
</crud:putExecutionFile>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:putExecutionFileResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>9</return>
</ns2:putExecutionFileResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:         public java.lang.Long putExecutionFile(java.lang.String id,
                                                                                                             java.lang.String filename,
                                                                                                            javax.activation.DataHandler data,
                                                                                                            java.lang.String sessionId)                                                                             throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                                 com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:                 

import javax.activation.DataHandler;
import javax.activation.DataSource;
import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();
Long size = 0L;
String where="ExecutionFile";
InputStream in= new FileInputStream("InputStreamToFile.txt");
DataSource dataSource = new DataSource() {

@Override
public InputStream getInputStream() throws IOException {
return in;
}

@Override
public OutputStream getOutputStream() throws IOException {
return null;
}

@Override
public String getContentType() {
return "application/octet-stream";
}

@Override
public String getName() {
return where;
}
};


DataHandler dataHandler = new DataHandler(dataSource);

size = stub.putExecutionFile("13172", where, dataHandler, "125003101229.F1BE.46B1.1DA3.4544.A25F.69E8");

 

deleteExecutionFile

Delete a file associated with an Execution.

Parameters

Name Type Description

id

String
id of the Execution
filename
String
name of the file to delete
sessionId
String
sessionId of the current session

Returns

Name Type Description
Nuber Of Bytes
Long
number of bytes deleted

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:deleteExecutionFile>
<!--Optional:-->
<executionId>3dc247c2-1abb-47be-a698-788bf37339e4</executionId>
<!--Optional:-->
<filename>TestExecutionFile</filename>
<!--Optional:-->
<sessionId>125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA</sessionId>
</crud:deleteExecutionFile>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:deleteExecutionFileResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>10</return>
</ns2:deleteExecutionFileResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:        public java.lang.Long deleteExecutionFile(java.lang.String id,
                                                                                                                 java.lang.String filename,
                                                                                                                 java.lang.String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:             

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import javax.activation.DataHandler;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Long deletedbytes=stub.deleteExecutionFile("3dc247c2-1abb-47be-a698-788bf37339e4", "TestExecutionFile", "125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA");

 

startExecution

Start an execution referenced by id.

Parameters

Name Type Description
id
String
id of the execution to start
sessionId
String
sessionId of the current session

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:startExecution>
<!--Optional:-->
<id>3dc247c2-1abb-47be-a698-788bf37339e4</id>
<!--Optional:-->
<sessionId>125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA</sessionId>
</crud:startExecution>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:startExecutionResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity"/>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:       public void startExecution(java.lang.String id, java.lang.String sessionId)
                                                 throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                                 com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:             

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

stub..startExecution("3dc247c2-1abb-47be-a698-788bf37339e5", "125003101223.B2F3.63B7.6FA8.469B.9FDE.30AA");

 

loginByExecution

This method is deprecated.

Parameters

Name Type Description
executionId
String
the unique id of the Execution

Returns

Name Type Description
Login Result
LoginResult
loginResult object which wraps the visitorKey, the sessionId, a boolean indicating success or failure, and a
message associated with the result -- visitorKey will be null

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
    <soapenv:Header/>
    <soapenv:Body>
    <crud:loginByExecution>
    <!--Optional:-->
    <executionId>3dc247c2-1abb-47be-a698-788bf37339e4</executionId>
    </crud:loginByExecution>
    </soapenv:Body>
    </soapenv:Envelope>

 

SOAP Response

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
    <ns2:loginResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
    <return>
    <message>Login was successful.</message>
    <sessionId>125003101221.FFBE.5795.0733.4D8B.9D0D.AB5C</sessionId>
    <success>true</success>
    <visitorKey>null</visitorKey>
    </return>
    </ns2:loginResponse>
    </S:Body>
    </S:Envelope>

 

Java Code Sample

Method Sidgnature:      public com.pervasive.datasolutions.datacloud.service.LoginResult
                                                                                                     loginByExecution(java.lang.String executionId)
                                  throws com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException                       
                                           

Usage:    

import com.pervasive.datasolutions.api.crud.LoginResult;
import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

LoginResult result = stub..loginByExecution("125003110110.24AE.EB8A.BF6F.4F03.8CED.1ACE");

 

login

Login and start a session with the API. Backends against pervasive membership service

Parameters

Name Type Description
username
String
the username of the user
password
String
the password of the user

Returns

Name Type Description
Login Result
LoginResult
loginResult object which wraps the visitorKey, the sessionId, a boolean indicating success or failure, and a
message associated with the result

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
    <soapenv:Header/>
    <soapenv:Body>
    <crud:login>
    <!--Optional:-->
    <username>shuckertestuser</username>
    <!--Optional:-->
    <password>password</password>
    </crud:login>
    </soapenv:Body>
    </soapenv:Envelope>

 

SOAP Response

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
    <ns2:loginResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
    <return>
    <message>Login was successful.</message>
    <sessionId>125003101221.FFBE.5795.0733.4D8B.9D0D.AB5C</sessionId>
    <success>true</success>
    <visitorKey>10120813994482064946</visitorKey>
    </return>
    </ns2:loginResponse>
    </S:Body>
    </S:Envelope>

 

Java Code Sample

Method Sidgnature:      public com.pervasive.datasolutions.datacloud.service.LoginResult
                                                                                                     login(java.lang.String username,
                                                                                                              java.lang.String password)
                                  throws com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException                       
                                           

Usage:    

import com.pervasive.datasolutions.api.crud.LoginResult;
import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

LoginResult result = stub.login("shuckertestuser","password");

 

logout

Logout and terminate the API session.

Parameters

Name Type Description
sessionId
String
sessionId of the current session

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
    <soapenv:Header/>
    <soapenv:Body>
    <crud:logout>
    <!--Optional:-->
    <sessionId>125003101221.FFBE.5795.0733.4D8B.9D0D.AB5C</sessionId>
    </crud:logout>
    </soapenv:Body>
    </soapenv:Envelope>

 

SOAP Response

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
    <ns2:logoutResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity"/>
    </S:Body>
    </S:Envelope>  

 

Java Code Sample

Method Sidgnature:         public void logout(java.lang.String sessionId)                                                                
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:  

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

stub.logout("125003101227.4253.DC58.5A73.4AC1.AED2.5687");

 

createGroup

Create a new group associated with user's account. To use this method user must be an administrator.

Parameters

Name Type Description
group
Group
the group to create
sessionId
String
the currently active sessionId

Returns

Name Type Description
Group
Group
the newly created group object

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:createGroup>
<!--Optional:-->
<group permissions="" id="1">
<!--Optional:-->
<owner id="1362">ds.test</owner>
<!--Optional:-->
<account>1</account>
<!--Optional:-->
<createdby>1362</createdby>
<!--Optional:-->
<createddate>2011-11-2</createddate>
<!--Optional:-->
<deleted>false</deleted>
<!--Optional:-->
<group>1</group>
<!--Optional:-->
<lastmodifiedby>1362</lastmodifiedby>
<!--Optional:-->
<lastmodifieddate>2012-11-02</lastmodifieddate>
<!--Optional:-->
<name>UnitTestGroup-1318948936722</name>
<!--Optional:-->
<parameters>
<!--Zero or more repetitions:-->
<parameter key="testparameter" secure="true">testparametervalue</parameter>
</parameters>
<!--Optional:-->
<type>Test</type>
</group>
<!--Optional:-->
<sessionId>30fa4f5a-f67c-4ea0-a6a7-60f2e2c3f9c3</sessionId>
</crud:createGroup>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:createGroupResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return id="350" permissions="">
<owner id="1362">ds.test</owner>
<account>1</account>
<createdby>1362</createdby>
<deleted>false</deleted>
<group>350</group>
<lastmodifiedby>1362</lastmodifiedby>
<name>UnitTestGroup-1318948936722</name>
<parameters>
<parameter secure="true" key="testparameter"/>
</parameters>
<type>Test</type>
</return>
</ns2:createGroupResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:        public com.pervasive.datasolutions.datacloud.persistence.ent.Group                                                                           createGroup(com.pervasive.datasolutions.datacloud.persistence.ent.Group group,                                                                                                                                                              String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,                                               com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:              

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import com.pervasive.datasolutions.api.entity.GroupParameter;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Group g=new Group();
User u=new User();

g.setCreatedby(u);
g.setCreateddate((long) (2010-05-14));
g.setDeleted(true);
g.setId(1);

g.setLastmodifiedby(u);
g.setLastmodifieddate((long) (2010-05-14));
g.setName("testgroup");

g.setGroup(2);

UserInfo uf=new UserInfo();
uf.setId(172);
uf.set_value("testuser");
g.setOwner(uf);

GroupParameter[] gparameter=new GroupParameter[5];
gparameter[0].setKey("ProductKey");
gparameter[0].set_value("ProductValue");
gparameter[0].setSecure(true);

g.setParameters(gparameter);
g.setPermissions("READ");
g.setType("grouptype");

Group newGroup=stub.createGroup(g, "2bcd6cc0-bf9b-49c0-9fca-80742cc80df7");

 

findGroup

Return a group by id.

Parameters

Name Type Description
id
Long
id of the group to return
sessionId
String
sessionId of the current session

Returns

Name Type Description
Group
Group
the group

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:findGroup>
<!--Optional:-->
<id>1</id>
<!--Optional:-->
<sessionId>30fa4f5a-f67c-4ea0-a6a7-60f2e2c3f9c3</sessionId>
</crud:findGroup>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findGroupResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return id="1" permissions="">
<owner id="1362">ds.test</owner>
<account>1</account>
<deleted>false</deleted>
<group>1</group>
<name>UnitTestGroup-1318948936722</name>
<parameters>
<parameter secure="true" key="testparameter"/>
</parameters>
<type>Test</type>
</return>
</ns2:findGroupResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:         public com.pervasive.datasolutions.datacloud.persistence.ent.Group                                                                                                        findGroup(Long id, String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:      

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Group group = stub.findGroup(150, "c77a1f09-6b97-4944-b1bb-8af1872f9934");

 

editGroup

Edit a group object associated with the user's account.

Parameters

Name Type Description
group
Group
the new value of the group object
sessionId
String
sessionId of the current session

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:editGroup>
<!--Optional:-->
<group permissions="?" id="1">
<!--Optional:-->
<owner id="1362">ds.test</owner>
<!--Optional:-->
<account>1</account>
<!--Optional:-->
<createdby>1362</createdby>
<!--Optional:-->
<createddate>2011-11-2</createddate>
<!--Optional:-->
<deleted>false</deleted>
<!--Optional:-->
<group>1</group>
<!--Optional:-->
<lastmodifiedby>1362</lastmodifiedby>
<!--Optional:-->
<lastmodifieddate>2012-11-2</lastmodifieddate>
<!--Optional:-->
<name>UnitTestGroup-1318948936722</name>
<!--Optional:-->
<parameters>
<!--Zero or more repetitions:-->
<parameter key="testparameter" secure="true">testparametervalue</parameter>
</parameters>
<!--Optional:-->
<type>Test</type>
</group>
<!--Optional:-->
<sessionId>30fa4f5a-f67c-4ea0-a6a7-60f2e2c3f9c3</sessionId>
</crud:editGroup>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:editGroupResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity"/>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:        void editGroup (com.pervasive.datasolutions.datacloud.persistence.ent.Group group,
                                                                                                                                        String sessionId)
                                                throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                                com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

 

Usage:                  

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import com.pervasive.datasolutions.api.entity.GroupParameter;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Group g=new Group();
User u=new User();

g.setCreatedby(u);
g.setCreateddate((long) (2010-05-14));
g.setDeleted(true);
g.setId(1);

g.setLastmodifiedby(u);
g.setLastmodifieddate((long) (2010-05-14));
g.setName("testgroup");

UserInfo uf=new UserInfo();
uf.setId(172);
uf.set_value("testuser");
g.setOwner(uf);

g.setGroup(2);

GroupParameter[] gparameter=new GroupParameter[5];
gparameter[0].setKey("ProductKey");
gparameter[0].set_value("ProductValue");
gparameter[0].setSecure(true);

g.setParameters(gparameter);
g.setPermissions("READ");
g.setType("grouptype");

stub.editUser(u, "125003101227.4253.DC58.5A73.4AC1.AED2.5687");

 

listGroups

List the groups associated with the current user.

Parameters

Name Type Description
firstResult
Integer
0-indexed ordinal of the first record to return
maxResults
Integer
the maximum number of records to return
sessionId
String
sessionId of the current session

Returns

Name Type Description
Group(0..*)
List<Group>
a list of Groups

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:listGroups>
<!--Optional:-->
<firstResult>0</firstResult>
<!--Optional:-->
<maxResults>2</maxResults>
<!--Optional:-->
<sessionId>30fa4f5a-f67c-4ea0-a6a7-60f2e2c3f9c3</sessionId>
</crud:listGroups>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:listGroupsResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return id="1" permissions="">
<owner id="1362">ds.test</owner>
<account>1</account>
<deleted>false</deleted>
<group>1</group>
<name>UnitTestGroup-1318948936722</name>
<parameters/>
<type>Test</type>
</return>
<return id="2" permissions="">
<owner id="1362">ds.test</owner>
<account>1</account>
<deleted>false</deleted>
<group>2</group>
<name>UnitTestGroup-1318971711237</name>
<parameters/>
<type>Test</type>
</return>
</ns2:listGroupsResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:         List<com.pervasive.datasolutions.datacloud.persistence.ent.Group>listGroups                                                                                                                                                      (Integer firstResult,
                                                                                                                                            Integer maxResult,
                                                                                                                                               String sessionId)
                                             throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                             com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:              

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import java.util.List;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

List<Group> groupList = stub.listGroups(0, 100, "c77a1f09-6b97-4944-b1bb-8af1872f9934");

 

deleteGroup

Delete a group by id. To use this method user must be an administrator.

Parameters

Name Type Description
id
Long
id of the group to delete
sessionId
String
sessionId of the current session

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:deleteGroup>
<!--Optional:-->
<id>10</id>
<!--Optional:-->
<sessionId>30fa4f5a-f67c-4ea0-a6a7-60f2e2c3f9c3</sessionId>
</crud:deleteGroup>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:deleteGroupResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity"/>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:         void deleteGroup(Long id, String sessionId)
                                                 throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                                 com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:           

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

stub.deleteGroup(154, "b71cf2d8-a5e8-4563-89a7-4bacdcc9c72f");

 

getGroupCount

Count the Groups to which the current user has access.

Parameters

Name Type Description
sessionId
String
sessionId of the current session

Returns

Name Type Description
Group Count
Long
count of Groups

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:getGroupCount>
<!--Optional:-->
<sessionId>30fa4f5a-f67c-4ea0-a6a7-60f2e2c3f9c3</sessionId>
</crud:getGroupCount>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getGroupCountResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>103</return>
</ns2:getGroupCountResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:       Long getGroupCount(String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:    

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Long groupCount=stub.getGroupCount("b71cf2d8-a5e8-4563-89a7-4bacdcc9c72f");

 

getGroupParameter

Return the value of a parameter associated with a Group referenced by id.

Parameters

Name Type Description
id
Long
the id of the Group
key
String
the key of the parameter to return
sessionId
String
sessionId of the current session

Returns

Name Type Description
Parameter Value
String
the value of the parameter

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:getGroupParameter>
<!--Optional:-->
<id>1</id>
<!--Optional:-->
<key>awsAccessKey</key>
<!--Optional:-->
<sessionId>30fa4f5a-f67c-4ea0-a6a7-60f2e2c3f9c3</sessionId>
</crud:getGroupParameter>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getGroupParameterResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>awsAccessvalue</return>
</ns2:getGroupParameterResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:       String getGroupParameter(Long id, String key, String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:           

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

String groupParameter=stub.getGroupParameter(150, "testputgroupparameter", "c77a1f09-6b97-4944-b1bb-8af1872f9934");

 

putGroupParameter

Store a key/value pair associated with a Group identified by id.

Parameters

Name Type Description
id
Long
the id of the Group
key
String
the key of the parameter
value
String
the value of the parameter
sessionId
String
sessionId of the current session

Returns

Name Type Description
Parameter Value
String
the old value of the parameter, or null if it is a new parameter

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:putGroupParameter>
<!--Optional:-->
<id>1</id>
<!--Optional:-->
<key>awsAccessKey</key>
<!--Optional:-->
<value>awsAccessvalue</value>
<!--Optional:-->
<sessionId>30fa4f5a-f67c-4ea0-a6a7-60f2e2c3f9c3</sessionId>
</crud:putGroupParameter>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:putGroupParameterResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>awsAccessvalue</return>
</ns2:putGroupParameterResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Signature:       String putGroupParameter(Long id, String key, String value, String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:      

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

String groupParameter=stub.putGroupParameter(150, "awsAccessKey", "awsAccessvalue", "b71cf2d8-a5e8-4563-89a7-4bacdcc9c72f");

 

removeGroupParameter

Remove a parameter from a Group.

Parameters

Name Type Description
id
Long
the id of the Group from which to remove a parameter
key
String
the key of the parameter
sessionId
String
sessionId of the current session

Returns

Name Type Description
Parameter Value
String
the old value of the parameter

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:removeGroupParameter>
<!--Optional:-->
<id>1</id>
<!--Optional:-->
<key>awsAccessKey</key>
<!--Optional:-->
<sessionId>30fa4f5a-f67c-4ea0-a6a7-60f2e2c3f9c3</sessionId>
</crud:removeGroupParameter>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:removeGroupParameterResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>awsAccessvalue</return>
</ns2:removeGroupParameterResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:        String removeGroupParameter(Long id, String key, String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:      

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

String parameterValue=stub.removeGroupParameter(150, "groupKey", "b71cf2d8-a5e8-4563-89a7-4bacdcc9c72f");

 

listGroupFiles

List files associated with an Group.

Parameters

Name Type Description
id
Long
id of the Group
sessionId
String
sessionId of the current session

Returns

Name Type Description
File Names
List<String>
List of file names associated with the Group

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:listGroupFiles>
<!--Optional:-->
<id>1</id>
<!--Optional:-->
<sessionId>30fa4f5a-f67c-4ea0-a6a7-60f2e2c3f9c3</sessionId>
</crud:listGroupFiles>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:listGroupFilesResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>test</return>
</ns2:listGroupFilesResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:        List<String> listGroupFiles(Long id, String sessionId)
                                                 throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                                 com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException
                                             

Usage:     

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import java.util.List;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

List<String> filelist=stub.listGroupFiles(150, "c77a1f09-6b97-4944-b1bb-8af1872f9934");

 

getGroupFile

Download a file associated with a Group.

Parameters

Name Type Description
id
Long
id of the Group
filename
String
name of the file to download
sessionId
String
sessionId of the current session

Returns

Name Type Description
Group File
DataHandler
DataHandler wrapping the file data

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:getGroupFile>
<!--Optional:-->
<id>1</id>
<!--Optional:-->
<filename>test</filename>
<!--Optional:-->
<sessionId>30fa4f5a-f67c-4ea0-a6a7-60f2e2c3f9c3</sessionId>
</crud:getGroupFile>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getGroupFileResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>cid301216703</return>
</ns2:getGroupFileResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:         DataHandler getGroupFile(Long id, String filename, String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:          

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;
import javax.activation.DataHandler

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

DataHandler fileHandlr = null;
fileHandlr = stub.getGroupFile(150, "testgroupfile", "c77a1f09-6b97-4944-b1bb-8af1872f9934");

 

putGroupFile

Upload a file associated with a Group.

Parameters

Name Type Description
id
Long
id of the Group
filename
String
name of the file to upload
data
DataHandler
DataHandler wrapping the file data
sessionId
String
sessionId of the current session

Returns

Name Type Description
Number Of Bytes
Long
the number of bytes written

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:putGroupFile>
<!--Optional:-->
<id>1</id>
<!--Optional:-->
<filename>test</filename>
<!--Optional:-->
<data>cid:301216703454</data>
<!--Optional:-->
<sessionId>30fa4f5a-f67c-4ea0-a6a7-60f2e2c3f9c3</sessionId>
</crud:putGroupFile>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:putGroupFileResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>9</return>
</ns2:putGroupFileResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:         Long putGroupFile(Long id, String filename, DataHandler data,String sessionId)                                                         throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                               com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:         

import javax.activation.DataHandler;
import javax.activation.DataSource;
import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Long size = 0L;
String where="UserFile";
InputStream in= new FileInputStream("InputStreamToFile.txt");
DataSource dataSource = new DataSource() {

@Override
public InputStream getInputStream() throws IOException {
return in;
}

@Override
public OutputStream getOutputStream() throws IOException {
return null;
}

@Override
public String getContentType() {
return "application/octet-stream";
}

@Override
public String getName() {
return where;
}
};
DataHandler dataHandler = new DataHandler(dataSource);

size = stub.putGroupFile(150, where, dataHandler, "c77a1f09-6b97-4944-b1bb-8af1872f9934");

 

deleteGroupFile

Delete a file associated with a Group.

Parameters

Name Type Description
id
Long
id of the Group
filename
String
name of the file to delete
sessionId
String
sessionId of the current session

Returns

Name Type Description
Number Of Bytes
Long
number of bytes deleted

Errors

Name
CloudAPIException
InvalidSessionException

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:crud="http://datasolutions.pervasive.com/api/crud">
<soapenv:Header/>
<soapenv:Body>
<crud:deleteGroupFile>
<!--Optional:-->
<id>1</id>
<!--Optional:-->
<filename>test</filename>
<!--Optional:-->
<sessionId>30fa4f5a-f67c-4ea0-a6a7-60f2e2c3f9c3</sessionId>
</crud:deleteGroupFile>
</soapenv:Body>
</soapenv:Envelope>

 

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:deleteGroupFileResponse xmlns:ns2="http://datasolutions.pervasive.com/api/crud" xmlns:ns3="http://datasolutions.pervasive.com/api/entity">
<return>9</return>
</ns2:deleteGroupFileResponse>
</S:Body>
</S:Envelope>

 

Java Code Sample

Method Sidgnature:        Long deleteGroupFile (Long id, String filename, String sessionId)
                                              throws com.pervasive.datasolutions.datacloud.exceptions.InvalidSessionException,
                                              com.pervasive.datasolutions.datacloud.exceptions.CloudAPIException

Usage:          

import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datasolutions.api.service.EntityAPIServiceLocator;
import com.pervasive.datasolutions.api.service.EntityAPIService;
import com.pervasive.datasolutions.api.crud.CloudAPIException;
import com.pervasive.datasolutions.api.crud.InvalidSessionException;
import com.pervasive.datasolutions.api.entity.*;
import com.pervasive.datasolutions.api.crud.*;

EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();

Long deletedbytes=stub.deleteGroupFile(150,"testgroupfile", "b71cf2d8-a5e8-4563-89a7-4bacdcc9c72f");