User Guide > User Guide > DataCloud API User Guide > Entity API Service > Provisioning
Was this helpful?
Provisioning
The following methods are available for manipulating the provisioning entity with the Entity API Service.
Note:  The following imports are required for all of the Java code examples on this page.
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.*;
Tip...  Use the login method to start a session and obtain the sessionId parameter. See Login and Logout.
listProvisionings
List the provisionings associated with the current user.
Parameters
 
Name
Type
Description
Required?
firstResults
Integer
0-indexed ordinal of the first record to return.
No.
maxResult
Integer
Maximum number of records to return.
No.
sessionId
String
ID of the current user session.
Yes.
Returns
 
Name
Type
Description
Provisioning(0..*)
List<Provisioning>
List of provisionings.
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>
            <firstResult>0</firstResult>
            <maxResults>100</maxResults>
            <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">testuser</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>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">testuser</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
final int firstResult = 0;
final int maxResults = 100;
final String sessionId = "125003101227.4253.DC58.5A73.4AC1.AED2.5687";
import java.util.List;
EntityAPIServiceLocator service = new EntityAPIServiceLocator();
EntityAPIService stub = service.getEntityAPIPort();
List<Provisioning> prov = stub.listProvisionings(firstResult, maxResults, sessionId);
listProvisioningsByGroup
List the provisionings associated with the specified group.
Parameters
 
Name
Type
Description
Required?
firstResults
Integer
0-indexed ordinal of the first record to return.
No.
maxResult
Integer
Maximum number of records to return.
No.
id
Long
ID of the group.
Yes.
sessionId
String
ID of the current user session.
Yes.
Returns
 
Name
Type
Description
Provisioning(0..*)
List<Provisioning>
List of provisionings.
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>
            <firstResult>1</firstResult>
            <maxResults>1</maxResults>
            <id>1</id>
            <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
final int firstResult = 0;
final int maxResults = 100;
final Long id = 2;
final String sessionId = "125003101227.4253.DC58.5A73.4AC1.AED2.5687";
import java.util.List;
EntityAPIServiceLocator service = new EntityAPIServiceLocator();
EntityAPIService stub = service.getEntityAPIPort();
List<Provisioning> prov = stub.listProvisioningsByGroup (firstResult, maxResults, id, sessionId);
findProvisioning
Return a provisioning by ID.
Parameters
 
Name
Type
Description
Required?
id
Long
ID of the provisioning to return.
Yes.
sessionId
String
ID of the current user session.
Yes.
Returns
 
Name
Type
Description
Provisioning
Provisioning
The requested provisioning.
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>
            <id>12086</id>
            <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">testuser</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>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
final Long id = 12086;
final String sessionId = "125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130";
EntityAPIServiceLocator service = new EntityAPIServiceLocator();
EntityAPIService stub = service.getEntityAPIPort();
Provisioning p = stub.findProvisioning(id, sessionId);
createProvisioning
Create a new provisioning for a product owned by the current user.
Parameters
 
Name
Type
Description
Required?
provisioning
Provisioning
Provisioning to create.
Yes.
sessionId
String
ID of the current user session.
Yes.
Returns
 
Name
Type
Description
Provisioning
Provisioning
Newly created provisioning.
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>
            <provisioning permissions="read" id="12625">
                <owner id="171">testuser</owner>
                <account>100</account>
                <createdby>171</createdby>
                <createddate>2011-11-1</createddate>
                <expirationDate>2012-1-1</expirationDate>
                <group>2</group>
                <lastmodifiedby>171</lastmodifiedby>
                <lastmodifieddate>2011-11-1</lastmodifieddate>
                <name>testprovisioning</name>
                <parameters>
                    <!--Zero or more repetitions:-->
                    <parameter key="key1" secure="true">value</parameter>
                </parameters>
                <process>testprocess.ip.xml</process>
                <product>0d2c6593-9482-483b-a913-9cef2be60d100</product>
                <productOwnedId>355</productOwnedId>
                <schedule>0</schedule>
                <startDate>2011-11-1</startDate>
                <user>171</user>
            </provisioning>
            <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">testuser</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
final String sessionId = "125003101227.4253.DC58.5A73.4AC1.AED2.5687";
EntityAPIServiceLocator service = new EntityAPIServiceLocator();
EntityAPIService stub = service.getEntityAPIPort();
import java.text.SimpleDateFormat;
import java.util.Date;
Provisioning newProv = new Provisioning();
User u = new User();
newProv.setCreatedby(u);
newProv.setCreateddate((long) (2010-05-14));
Calendar expdate=Calendar.getInstance();
newProv.setExpirationDate(expdate);
newProv.setId(12086);
newProv.setLastmodifiedby(u);
newProv.setLastmodifieddate((long) (2010-06-14));
newProv.setName("TestProvisioning");
UserInfo uf = new UserInfo();
uf.setId(172);
uf.set_value("testuser");
newProv.setOwner(uf);
newProv.setPermissions("READ");
newProv.setProcess("Integration.ip.xml");
newProv.setProduct("0d2c6593-9482-483b-a913-9cef2be60d55");
newProv.setProductOwnedId("335");
newProv.setSchedule("0");
Calendar startDate=Calendar.getInstance();
newProv.setStartDate(startDate);
newProv.setUser((long) 171);
newProv.setGroup(2);
ProvisioningParameter[] prparameter=new ProvisioningParameter[5];
prparameter[0].setKey("provisioningKey");
prparameter[0].set_value("provisioningKeyValue");
prparameter[0].setSecure(true);
newProv.setParameters(prparameter);
Provisioning prov = stub.createProvisioning(newProv, sessionId);
editProvisioning
Edit a designated provisioning associated with the current user.
Parameters
 
Name
Type
Description
Required?
provisioning
provisioning
New value for the provisioning.
Yes.
sessionId
String
ID of the current user session.
Yes.
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>
            <provisioning permissions="" id="12625">
                <owner id="171">testuser</owner>
                <account>100</account>
                <createdby>171</createdby>
                <createddate>2011-11-1</createddate>
                <expirationDate>2012-1-1</expirationDate>
                <group>2</group>
                <lastmodifiedby>171</lastmodifiedby>
                <lastmodifieddate>2011-11-1</lastmodifieddate>
                <name>myProvisioning</name>
                <parameters>
                    <!--Zero or more repetitions:-->
                    <parameter key="myProvisioningKey" secure="no">myProvisioningValue</parameter>
                </parameters>
                <process>testprocess.ip.xml</process>
                <product>IDSSSBV-E01W201-91900-01</product>
                <productOwnedId>a1730000000K4bxAAC</productOwnedId>
                <schedule></schedule>
                <startDate>?</startDate>
                <user>47</user>
            </provisioning>
            <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
final String sessionId = "125003101227.4253.DC58.5A73.4AC1.AED2.5687";
EntityAPIServiceLocator service = new EntityAPIServiceLocator();
EntityAPIService stub = service.getEntityAPIPort();
Provisioning editedProv = new Provisioning();
User u = new User();
editedProv.setCreatedby(u);
editedProv.setCreateddate((long) (2010-05-14));
Calendar expdate=Calendar.getInstance();
editedProv.setExpirationDate(expdate);
editedProv.setId(12086);
editedProv.setLastmodifiedby(u);
editedProv.setLastmodifieddate((long) (2010-06-14));
editedProv.setName("TestProvisioning");
UserInfo uf=new UserInfo();
uf.setId(172);
uf.set_value("testuser");
editedProv.setOwner(uf1);
editedProv.setPermissions("READ");
editedProv.setGroup(2);
editedProv.setProcess("Integration.ip.xml");
editedProv.setProduct("0d2c6593-9482-483b-a913-9cef2be60d55");
editedProv.setProductOwnedId("335");
editedProv.setSchedule("0");
Calendar startDate=Calendar.getInstance();
editedProv.setStartDate(startDate);
editedProv.setUser((long) 171);
ProvisioningParameter[] prparameter=new ProvisioningParameter[5];
prparameter[0].setKey("provisioningKey");
prparameter[0].set_value("provisioningKeyValue");
prparameter[0].setSecure(true);
editedProv.setParameters(prparameter);
stub.editProvisioning(editedProv, sessionId);
deleteProvisioning
Delete a specified provisioning owned by the current user.
Parameters
 
Name
Type
Description
Required?
id
Long
ID of the provisioning to delete.
Yes.
sessionId
String
ID of the current user session.
Yes.
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>
            <id>43144</id>
            <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
final Long id = 12086;
final String sessionId = "125003101227.4253.DC58.5A73.4AC1.AED2.5687";
EntityAPIServiceLocator service = new EntityAPIServiceLocator();
com.pervasive.datasolutions.api.crud.EntityAPIService stub = service.getEntityAPIPort();
stub.deleteProvisioning(id, sessionId);
getProvisioningCount
Count the provisionings associated with the current user.
Parameters
 
Name
Type
Description
Required?
sessionId
String
ID of the current user session.
Yes.
Returns
 
Name
Type
Description
Provisioning Count
Long
Count of provisionings.
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>
            <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
final String sessionId = "125003101227.4253.DC58.5A73.4AC1.AED2.5687";
EntityAPIServiceLocator service = new EntityAPIServiceLocator();
EntityAPIService stub = service.getEntityAPIPort();
Long Count=stub.getProvisioningCount(sessionId);
getProvisioningParameter
Return the value of a parameter associated with a specified provisioning.
Parameters
 
Name
Type
Description
Required?
id
Long
ID of the provisioning.
Yes.
key
String
Key of the parameter to return.
Yes.
sessionId
String
ID of the current user session.
Yes.
Returns
 
Name
Type
Description
Parameter Value
String
Value of the parameter.
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>
            <id>12086</id>
            <key>provisioningkey</key>
            <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
final Long id = 12086;
final String key = "parameterKey";
final String sessionId = "125003101223.6634.326B.C412.41CD.8643.4190";
EntityAPIServiceLocator service = new EntityAPIServiceLocator();
EntityAPIService stub = service.getEntityAPIPort();
String ProvParameter=stub.getProvisioningParameter(id, key, sessionId);
putProvisioningParameter
Store a key/value pair associated with a specified provisioning.
Parameters
 
Name
Type
Description
Required?
id
Long
ID of the provisioning.
Yes.
key
String
Key of the parameter.
Yes.
value
String
Value of the parameter.
Yes.
sessionId
String
ID of the current user session.
Yes.
Returns
 
Name
Type
Description
Parameter Value
String
Old value of the parameter (or null if it is a new parameter).
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>
            <id>12086</id>
            <key>provisioningkey</key>
            <value>provisioningvalue</value>
            <sessionId>125003101223.6634.326B.C412.41CD.8643.4190</sessionId>
        </crud:putProvisioningParameter>
    </soapenv:Body>
</soapenv:Envelope>
SOAP Example
<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
final Long id = 12086;
final String key = "parameterKey";
final String value = "parameterValue";
final String sessionId = "125003101223.6634.326B.C412.41CD.8643.4190";
EntityAPIServiceLocator service = new EntityAPIServiceLocator();
EntityAPIService stub = service.getEntityAPIPort();
String ProvisioningParameter=stub.putProvisioningParameter(id, key, value, sessionId);
removeProvisioningParameter
Remove a parameter from a specified provisioning.
Parameters
 
Name
Type
Description
Required?
id
Long
ID of the provisioning from which to remove the parameter.
Yes.
key
String
Key of the parameter to remove.
Yes.
sessionId
String
ID of the current user session.
Yes.
Returns
 
Name
Type
Description
Parameter Value
String
Old value of the parameter.
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>
            <id>12086</id>
            <key>provisioningkey</key>
            <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
final Long id = 12086;
final String key = "parameterKey";
final String sessionId = "125003101223.6634.326B.C412.41CD.8643.4190";
EntityAPIServiceLocator service = new EntityAPIServiceLocator();
EntityAPIService stub = service.getEntityAPIPort();
String ParameterValue=stub.removeProvisioningParameter(id, key, sessionId);
listProvisioningFiles
List files associated with a specified provisioning.
Parameters
 
Name
Type
Description
Required?
id
Long
ID of the provisioning.
Yes.
sessionId
String
ID of the current user session.
Yes.
Returns
 
Name
Type
Description
File Names
List<java.lang.String>
List of file names associated with the provisioning.
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>
            <provisioningId>12086</provisioningId>
            <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>createdestination.jpg</return>
            <return>loading.gif</return> 
        </ns2:listProvisioningFilesResponse>
    </S:Body>
</S:Envelope>
Java Code Sample
final Long id = 12086;
final String sessionId = "125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7";
import java.util.List;
EntityAPIServiceLocator service = new EntityAPIServiceLocator();
EntityAPIService stub = service.getEntityAPIPort();
List<String> provisioningfiles = stub.listProvisioningFiles(id, sessionId);
getProvisioningFile
Download a file associated with a specified provisioning.
Parameters
 
Name
Type
Description
Required?
id
Long
ID of the provisioning.
Yes.
filename
String
Name of the file to download.
Yes.
sessionId
String
ID of the current user session.
Yes.
Returns
 
Name
Type
Description
Provisioning File
DataHandler
DataHandler wrapping the file data.
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>
            <provisioningId>12086</provisioningId>
            <filename>createdestination.jpg</filename>
            <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>
</S:Envelope>
Java Code Sample
final Long id = 12086;
final String filename = "testfile.txt";
final String sessionId = "125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7";
import javax.activation.DataHandler;
EntityAPIServiceLocator service = new EntityAPIServiceLocator();
EntityAPIService stub = service.getEntityAPIPort();
DataHandler fileHandlr = null;
fileHandlr = stub.getProvisioningFile(id, filename, sessionId);
putProvisioningFile
Upload a file associated with a specified provisioning.
Parameters
 
Name
Type
Description
Required?
id
Long
ID of the provisioning.
Yes.
filename
String
Name of the file to upload.
Yes.
data
DataHandler
DataHandler wrapping the file data.
Yes.
sessionId
String
ID of the current user session.
Yes.
Returns
 
Name
Type
Description
Number of Bytes
Long
Number of bytes uploaded.
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>
            <provisioningId>12086</provisioningId>
            <filename>createdestination.jpg</filename>
            <data>cid:561262630752</data>
            <sessionId>125003101222.7BEA.3DC4.0FDA.41CC.93F0.B130</sessionId>
        </crud:putProvisioningFile>
    </soapenv:Body>
</soapenv:Envelope>
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
final String filename = "testfile.txt";
final String sessionId = "125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7";
import javax.activation.DataHandler;
import javax.activation.DataSource;
EntityAPIServiceLocator service = new EntityAPIServiceLocator();
EntityAPIService stub = service.getEntityAPIPort();
Long size = 0L;
InputStream in= new FileInputStream(filename);
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 filename;
    }
};
DataHandler dataHandler = new DataHandler(dataSource);
filesize = stub.putProvisioningFile(id, filename, dataHandler, sessionId);
deleteProvisioningFile
Delete a file associated with a specified provisioning.
Parameters
 
Name
Type
Description
Required?
id
Long
ID of the provisioning.
Yes.
filename
String
Name of the file to delete.
Yes.
sessionId
String
ID of the current user session.
Yes.
Returns
 
Name
Type
Description
Number of Bytes
Long
Number of bytes deleted.
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>
            <provisioningId>12086</provisioningId>
            <filename>testfile</filename>
            <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
final Long id = 12086;
final String filename = "testproductfile.txt";
final String sessionId = "125003101226.E179.E9D3.3DA5.4598.A2DE.C3A7";
EntityAPIServiceLocator service = new EntityAPIServiceLocator();
EntityAPIService stub = service.getEntityAPIPort();
Long bytesdeleted=stub.deleteProvisioningFile(id, filename, sessionId);
Last modified date: 12/17/2021