CloudRest API RESTful WebService

CloudRest API WebService enables the deployment and management of Web based data services provided by Pervasive DataCloud. The resources exposed by this RESTful WebService API allows CRUD operations on DataCloud Entities like Product/Integration, Provisioning/RuntimeConfiguration, etc. using HTTP methods GET, POST, PUT and DELETE. This document lists all these resources with their right usage. Also sample Request and Response are provided for each resource.

Refer to this document for a general overview on DataCloud Entities

http://cloud.pervasive.com/Technical/CloudUsersGuide/PervasiveDataCloud2APIDocumentation.aspx

 

login

Login and start a session with the below mentioned resource. The provided username and password combination is authenticated against pervasive membership service and a sessionId is returned. This sessionid is to be used in all subsequent REST calls, either in the form of 'sessionid' cookie or as query parameter 's'

Parameters

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

Methods

Name
POST

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/login

    POST https://datacloud2.pervasive.com/EntityAPIService/REST/login HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/x-www-form-urlencoded
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 44

    username=testuser&password=mypass

Response

Header

    HTTP/1.1 200 OK
    Date: Tue, 05 Apr 2011 05:15:23 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Type: application/xml
    Content-Length: 256
    Set-Cookie: sessionid=125003110405.7959.32B6.31A6.4276.97E8.C404;Version=1
    Connection: close

application/xml

    <LoginResult>
    <message>Login was successful.</message>
    <sessionId>49bfe32d-df30-4797-a8b1-96da5c1b5609</sessionId>
    <success>true</success>
    <visitorKey>11042EB6A3DFE1A34B25</visitorKey>
    </LoginResult>

application/json


    {
    "message": " Login was successful.",
    "sessionId": "49bfe32d.df30.4797.a8b1.96da5c1b5609",
    "success": "true",
    "visitorKey": "11043AE84FD9155C4CD3"
    }

text/xml

    <LoginResult>
    <message>Login was successful.</message>
    <sessionId>49bfe32d.df30.4797.a8b1.96da5c1b5609</sessionId>
    <success>true</success>
    <visitorKey>1104B8419AE311204C07</visitorKey>
    </LoginResult>

 

loginAlternative

Login using alternative method. (GET instead of POST)

Parameters

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

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/login?username=testuser&password=mypass

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/login?username=testuser&password=mypass HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Date: Tue, 05 Apr 2011 05:17:00 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Type: application/xml
    Content-Length: 256
    Set-Cookie: sessionid=125003110405.8F55.78CE.7C90.4684.9A5B.3830;Version=1
    Connection: close

application/xml

    <LoginResult>
    <message>Login was successful.</message>
    <sessionId>49bfe32d-df30-4797-a8b1-96da5c1b5609</sessionId>
    <success>true</success>
    <visitorKey>1104B119CECE99F84359</visitorKey>
    </LoginResult>

application/json

    {
    "message": " Login was successful.",
    "sessionId": "49bfe32d-df30-4797-a8b1-96da5c1b5609",
    "success": "true",
    "visitorKey": "110462F0545B404D4F1E"
    }

text/xml

    <LoginResult>
    <message>Login was successful.</message>
    <sessionId>49bfe32d-df30-4797-a8b1-96da5c1b5609</sessionId>
    <success>true</success>
    <visitorKey>1104E067D5B4F3994553</visitorKey>
    </LoginResult>

 

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
start
Integer
0-indexed ordinal of the first record to return
max
Integer
the maximum number of records to return
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/product?max=10&start=0&s=49bfe32d-df30-4797-a8b1-96da5c1b5609

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/product?max=10&start=0&s=49bfe32d-df30-4797-a8b1-96da5c1b5609 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 19:18:28 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 5836

    Connection: keep-alive

application/xml

    <Product xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <item id="" permissions="">
    <owner id="171">testuser</owner>
    <active>false</active>
    <concurrent>false</concurrent>
    <deleted>false</deleted>
    <description>Sub Test</description>
    <destination>250</destination>
    <group>1244</group>
    <lastmodifieddate>-1909684168</lastmodifieddate>
    <name>Sub Test</name>
    <parameters/>
    <parentProvisioningId>15046</parentProvisioningId>
    <process/>
    <userProduct>true</userProduct>
    </item>
       .
       .
       .
    </Product>

application/json

    {"item": [
          {
          "@id": "",
          "@permissions": "",
          "owner":       {
             "@id": "171",
             "$": "testuser"
          },
          "active": "false",
          "concurrent": "false",
          "deleted": "false",
          "description": "Sub Test",
          "destination": "250",
          "group": "1244",
          "lastmodifieddate": "-1909684168",
          "name": "Sub Test",
          "parameters": null,
          "parentProvisioningId": "15046",
          "process": "",
          "userProduct": "true"
       },          
          {
          "@id": "19221ad8-2cbc-4752-90ef-76043771dcbb",
          "@permissions": "",
          "owner":       {
             "@id": "171",
             "$": "testuser"
          },
          "active": "true",
          "concurrent": "false",
          "deleted": "false",
          "description": "Reporting Machine Hours",
          "destination": "74",
          "group": "1244",
          "lastmodifieddate": "-1909684168",
          "name": "Reporting Machine Hours",
          "parameters": {"parameter":       [
             {"@key": "ODBC_TARGET_TABLE"},
             {"@key": "ODBC_TARGET"},
             {"@key": "dcurl"}
          ]},
          "parentProvisioningId": "13351",
          "process": "integrationSpec/machine_hours.djar",
          "userProduct": "true"
       }
    ]}

text/xml

    <Product>
    <item id="" permissions="">
    <owner id="171">testuser</owner>
    <active>false</active>
    <concurrent>false</concurrent>
    <deleted>false</deleted>
    <description>Sub Test</description>
    <destination>250</destination>
    <group>1244</group>
    <lastmodifieddate>-1909684168</lastmodifieddate>
    <name>Sub Test</name>
    <parameters/>
    <parentProvisioningId>15046</parentProvisioningId>
    <process/>
    <userProduct>true</userProduct>
    </item>
       .
       .
       .
    </Product>

 

findProduct

Return a product by id.

Parameters

Name Type Description
sku
String
the id of the product to return
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/product/00c55ba1-2fcb-4109-aa73-8ff2aa8d4af9?s=49bfe32d-df30-4797-a8b1-96da5c1b5609

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/product/00c55ba1-2fcb-4109-aa73-8ff2aa8d4af9?s=49bfe32d-df30-4797-a8b1-96da5c1b5609 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 19:27:40 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 752

    Connection: keep-alive

application/xml

    <Product id="00c55ba1-2fcb-4109-aa73-8ff2aa8d4af9" permissions="" xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <owner id="171">testuser</owner>
    <active>true</active>
    <concurrent>false</concurrent>
    <deleted>false</deleted>
    <description>PICCP Connector for MeS</description>
    <destination>73</destination>
    <group>1244</group>
    <lastmodifiedby>171</lastmodifiedby>
    <lastmodifieddate>-1909684168</lastmodifieddate>
    <name>PICCP MeS</name>
    <parameters>
    <parameter key="mykey2"/>
    <parameter key="ProviderID"/>
    <parameter key="ProviderConfig"/>
    </parameters>
    <parentProvisioningId>13351</parentProvisioningId>
    <process/>
    <userProduct>true</userProduct>
    </Product>

application/json

    {
       "@id": "00c55ba1-2fcb-4109-aa73-8ff2aa8d4af9",
       "@permissions": "",
       "owner":    {
          "@id": "171",
          "$": "testuser"
       },
       "active": "true",
       "concurrent": "false",
       "deleted": "false",
       "description": "PICCP Connector for MeS",
       "destination": "73",
       "group": "1244",
       "lastmodifiedby": "171",
       "lastmodifieddate": "-1909684168",
       "name": "PICCP MeS",
       "parameters": {"parameter":    [
                {
             "@key": "mykey2",
             "$": ""
          },
                {
             "@key": "ProviderID",
             "$": ""
          },
                {
             "@key": "ProviderConfig",
             "$": ""
          }
       ]},
       "parentProvisioningId": "13351",
       "process": "",
       "userProduct": "true"
    }
    }

text/xml

    <Product id="00c55ba1-2fcb-4109-aa73-8ff2aa8d4af9" permissions="">
    <owner id="171">testuser</owner>
    <active>true</active>
    <concurrent>false</concurrent>
    <deleted>false</deleted>
    <description>PICCP Connector for MeS</description>
    <destination>73</destination>
    <group>1244</group>
    <lastmodifiedby>171</lastmodifiedby>
    <lastmodifieddate>-1909684168</lastmodifieddate>
    <name>PICCP MeS</name>
    <parameters>
    <parameter key="mykey2"/>
    <parameter key="ProviderID"/>
    <parameter key="ProviderConfig"/>
    </parameters>
    <parentProvisioningId>13351</parentProvisioningId>
    <process/>
    <userProduct>true</userProduct>
    </Product>

 

editProduct

Edit a custom Product object associated with the user.

Parameters

Name Type Description
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
POST

Example

Request
Header

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/product?s=49bfe32d-df30-4797-a8b1-96da5c1b5609

    POST https://datacloud2.pervasive.com/EntityAPIService/REST/product?s=49bfe32d-df30-4797-a8b1-96da5c1b5609 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 739

Body

    <Product id="00c55ba1-2fcb-4109-aa73-8ff2aa8d4af9" permissions="" xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <owner id="171">testuser</owner>
    <active>true</active>
    <concurrent>false</concurrent>
    <deleted>false</deleted>
    <description>PICCP Connector for MeS</description>
    <destination>73</destination>
    <group>1244</group>
    <lastmodifiedby>171</lastmodifiedby>
    <lastmodifieddate>-1909684168</lastmodifieddate>
    <name>PICCP MeS</name>
    <parameters>
    <parameter key="mykey2"/>
    <parameter key="ProviderID"/>
    <parameter key="ProviderConfig"/>
    </parameters>
    <parentProvisioningId>13351</parentProvisioningId>
    <process/>
    <userProduct>true</userProduct>
    </Product>

Response
Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 19:33:33 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

putProductFile

Upload a file associated with a Product.

Parameters

Name Type Description
productid
String
SKU of the Product
filename
String
name of the file to upload
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
PUT

Example

Request
Header

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/product/00c55ba1-2fcb-4109-aa73-8ff2aa8d4af9/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609 &filename=sampleFile.txt

    PUT https://datacloud2.pervasive.com/EntityAPIService/REST/product/00c55ba1-2fcb-4109-aa73-8ff2aa8d4af9/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/octet-stream
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 365

application/octet-stream

    <application xmlns="http://wadl.dev.java.net/2009/02">
    <doc xml:lang="en" title="login"/>
    <resources base="https://datacloud2.pervasive.com">
    <resource path="EntityAPIService/REST/postget/login" id="login">
    <doc xml:lang="en" title="login"/>
    <method name="GET" id="Method 1">
    <doc xml:lang="en" title="Method 1"/>
    <request/>
    </method>
    </resource>
    </resources>
    </application>

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 19:38:14 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

getProductFile

Download a file associated with a Product.

Parameters

Name Type Description
productid
String
SKU of the Product
filename
String
name of the file to download
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/product/00c55ba1-2fcb-4109-aa73-8ff2aa8d4af9/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/product/00c55ba1-2fcb-4109-aa73-8ff2aa8d4af9/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/octet-stream
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    content-disposition: attachment; filename=sampleFile.txt
    Content-Type: application/octet-stream
    Date: Thu, 10 Nov 2011 19:49:38 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 365

    Connection: keep-alive

application/octet-stream

    <application xmlns="http://wadl.dev.java.net/2009/02">
    <doc xml:lang="en" title="login"/>
    <resources base="https://datacloud2.pervasive.com">
    <resource path="EntityAPIService/REST/postget/login" id="login">
    <doc xml:lang="en" title="login"/>
    <method name="GET" id="Method 1">
    <doc xml:lang="en" title="Method 1"/>
    <request/>
    </method>
    </resource>
    </resources>
    </application>

 

deleteProductFile

Delete a file associated with a Product.

Parameters

Name Type Description
productid
String
SKU of the Product
filename
String
name of the file to delete
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
DELETE

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/product/00c55ba1-2fcb-4109-aa73-8ff2aa8d4af9/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt

    DELETE https://datacloud2.pervasive.com/EntityAPIService/REST/product/00c55ba1-2fcb-4109-aa73-8ff2aa8d4af9/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1

    Host: datacloud2.pervasive.com


Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 19:54:11 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

listProvisionings

List the provisionings associated with the current user.

Parameters

Name Type Description
start
Integer
0-indexed ordinal of the first record to return
max
Integer
the maximum number of records to return
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/provisioning?max=5&start=0&s=49bfe32d-df30-4797-a8b1-96da5c1b5609

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/provisioning?max=5&start=0&s=49bfe32d-df30-4797-a8b1-96da5c1b5609 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 19:56:26 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 1843
    Connection: keep-alive

application/xml

    <Provisioning xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <item id="12086" permissions="">
    <owner id="171">testuser</owner>
    <expirationDate>2010-06-25T04:00:00Z</expirationDate>
    <parameters/>
    <product>IDSSSBV-E01W201-91900-01</product>
    <productOwnedId>a1730000000K26vAAC</productOwnedId>
    <user>171</user>
    </item>
    <item id="12492" permissions="READ WRITE EXECUTE GRANT">
    <owner id="171">testuser</owner>
    <name>12492</name>
    <parameters/>
    <process/>
    <product>9fbdcc17-1329-4a2d-8df6-5d20b16d8c22</product>
    <schedule>0</schedule>
    <startDate>2009-10-01T04:00:00Z</startDate>
    <user>171</user>
    </item>
       .
       .
       .
    </Provisioning>

application/json

    {"item": [
    {
    "@id": "12086",
    "@permissions": "",
    "owner":       {
    "@id": "171",
    "$": "testuser"
    },
    "expirationDate": "2010-06-25T04:00:00Z",
    "parameters": null,
    "product": "IDSSSBV-E01W201-91900-01",
    "productOwnedId": "a1730000000K26vAAC",
    "user": "171"
    },
    {
    "@id": "12349",
    "@permissions": "",
    "owner":       {
    "@id": "171",
    "$": "testuser"
    },
    "expirationDate": "2012-12-31T05:00:00Z",
    "lastmodifiedby": "171",
    "name": "testprovivsioning",
    "parameters": {"parameter":       {
    "@secure": "true",
    "@key": "testparameterkey"
    }},
    "process": "sampleprocess",
    "product": "IDSCREDL-E01W201-91900-01",
    "productOwnedId": "a1730000000XgrEAAS",
    "schedule": "0",
    "startDate": "2009-10-22T04:00:00Z",
    "user": "171"
    },
    {
    "@id": "12492",
    "@permissions": "READ WRITE EXECUTE GRANT",
    "owner":       {
    "@id": "171",
    "$": "testuser"
    },
    "name": "12492",
    "parameters": null,
    "process": "",
    "product": "9fbdcc17-1329-4a2d-8df6-5d20b16d8c22",
    "schedule": "0",
    "startDate": "2009-10-01T04:00:00Z",
    "user": "171"
    }
    ]}

text/xml

    <Provisioning>
    <item id="12086" permissions="">
    <owner id="171">testuser</owner>
    <expirationDate>2010-06-25T04:00:00Z</expirationDate>
    <parameters/>
    <product>IDSSSBV-E01W201-91900-01</product>
    <productOwnedId>a1730000000K26vAAC</productOwnedId>
    <user>171</user>
    </item>
    <item id="12492" permissions="READ WRITE EXECUTE GRANT">
    <owner id="171">testuser</owner>
    <name>12492</name>
    <parameters/>
    <process/>
    <product>9fbdcc17-1329-4a2d-8df6-5d20b16d8c22</product>
    <schedule>0</schedule>
    <startDate>2009-10-01T04:00:00Z</startDate>
    <user>171</user>
    </item>
       .
       .
       .
    </Provisioning>

 

findProvisioning

Return a provisioning by id.

Parameters

Name Type Description
id
Long
id of the provisioning to return
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

Url: https://datacloud2.pervasive.com/EntityAPIService/REST/provisioning/12086?s=49bfe32d-df30-4797-a8b1-96da5c1b5609

GET https://datacloud2.pervasive.com/EntityAPIService/REST/provisioning/12086?s=49bfe32d-df30-4797-a8b1-96da5c1b5609 HTTP/1.1
Accept-Encoding: gzip,deflate
Accept: application/xml
User-Agent: Jakarta Commons-HttpClient/3.1
Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 20:00:59 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 383
    Connection: keep-alive

application/xml

    <Provisioning id="12086" permissions="" xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <owner id="171">testuser</owner>
    <expirationDate>2010-06-25T04:00:00Z</expirationDate>
    <parameters/>
    <product>IDSSSBV-E01W201-91900-01</product>
    <productOwnedId>a1730000000K26vAAC</productOwnedId>
    <user>171</user>
    </Provisioning>

application/json

    {
    "@id": "12086",
    "@permissions": "",
    "owner":    {
    "@id": "171",
    "$": "testuser"
    },
    "expirationDate": "2010-06-25T04:00:00Z",
    "parameters": null,
    "product": "IDSSSBV-E01W201-91900-01",
    "productOwnedId": "a1730000000K26vAAC",
    "user": "171"
    }

text/xml

    <Provisioning id="12086" permissions="">
    <owner id="171">testuser</owner>
    <expirationDate>2010-06-25T04:00:00Z</expirationDate>
    <parameters/>
    <product>IDSSSBV-E01W201-91900-01</product>
    <productOwnedId>a1730000000K26vAAC</productOwnedId>
    <user>171</user>
    </Provisioning>

 

editProvisioning

Edit a provisioning associated with a user.

Parameters

Name Type Description
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
POST

Example

Request
Header

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/provisioning?s=49bfe32d-df30-4797-a8b1-96da5c1b5609

    POST https://datacloud2.pervasive.com/EntityAPIService/REST/provisioning?s=49bfe32d-df30-4797-a8b1-96da5c1b5609 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 112

Body

    <Provisioning id="12086">
    <parameters>
    <parameter key="mykey">myValue</parameter>
    </parameters>
    </Provisioning>

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 20:05:52 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

putProvisioningFile

Upload a file associated with a Provisioning.

Parameters

Name Type Description
provisioningid
Long
id of the Provisioning
filename
String
name of the file to upload
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
PUT

Example

Request

Header

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/provisioning/12086/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt

    PUT https://datacloud2.pervasive.com/EntityAPIService/REST/provisioning/12086/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/octet-stream
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 124

application/octet-stream

    This is the content of a sample file named sampleFile.txt
    Second line of the sample file content.
    End of the Sample content

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 20:09:16 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

getProvisioningFile

Download a file associated with a Provisioning.

Parameters

Name Type Description
provisioningid
Long
id of the Provisioning
filename
String
name of the file to upload
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/provisioning/12086/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/provisioning/12086/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/octet-stream
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    content-disposition: attachment; filename=sampleFile.txt
    Content-Type: application/octet-stream
    Date: Thu, 10 Nov 2011 20:12:10 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 124
    Connection: keep-alive

application/octet-stream

    This is the content of a sample file named sampleFile.txt
    Second line of the sample file content.
    End of the Sample content

 

deleteProvisioningFile

Delete a file associated with a Provisioning .

Parameters

Name Type Description
provisioningid
Long
the id of the Provisioning
filename
String
filename to delete
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
DELETE

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/credential/2972028/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt

    DELETE https://datacloud2.pervasive.com/EntityAPIService/REST/credential/2972028/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/octet-stream
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    content-disposition: attachment; filename=sampleFile.txt
    Content-Type: application/octet-stream
    Date: Thu, 10 Nov 2011 20:36:22 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 124
    Connection: keep-alive

 

getTypeParameter

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

Parameters

Methods

Name Type Description
entityType
String
name of the entitytype
id
Long
id of the entityType
name
String
the key of the parameter to return
s
String
If the cookie is set with the "sessionId" , "s" is optional
Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/provisioning/12086/parameter?name=mykey2&s=49bfe32d-df30-4797-a8b1-96da5c1b5609

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/provisioning/12086/parameter?name=mykey2&s=49bfe32d-df30-4797-a8b1-96da5c1b5609 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: text/plain
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200  OK
    Content-Type: text/html; charset=UTF-8
    Date: Thu, 10 Nov 2011 21:47:38 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 1022

    Connection: keep-alive

text/xml

    myValue2

 

putTypeParameter

Post the value of a parameter associated with a entityType with referenced by id.

Parameters

Name Type Description
entityType
String
name of the entitytype
id
Long
id of the entityType
name
String
the key of the parameter to return
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
POST

Example

Request

Header

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/provisioning/12086/parameter?name=mykey2&s=49bfe32d-df30-4797-a8b1-96da5c1b5609

    POST https://datacloud2.pervasive.com/EntityAPIService/REST/provisioning/12086/parameter?name=mykey2&s=49bfe32d-df30-4797-a8b1-96da5c1b5609 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: text/plain
    Content-Type: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 8

Body

    myValue2

Response

Header

    HTTP/1.1 200  OK
    Content-Type: text/html; charset=UTF-8
    Date: Thu, 10 Nov 2011 21:43:30 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 1022
    Connection: keep-alive

 

listDestinations

List the destinations associated with the current user.

Parameters

Name Type Description
start
Integer
0-indexed ordinal of the first record to return
max
Integer
the maximum number of records to return
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/destination?max=10&start=0&s=49bfe32d-df30-4797-a8b1-96da5c1b5609

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/destination?max=10&start=0&s=49bfe32d-df30-4797-a8b1-96da5c1b5609 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Wed, 16 Nov 2011 10:27:29 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 857
    Connection: keep-alive

application/xml

    <Destination xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <item id="73">
    <owner id="171">testuser</owner>
    <amiId>ami-01f33e68</amiId>
    <availabilityzone>US-East-1a</availabilityzone>
    <concurrency>4</concurrency>
    <deleted>false</deleted>
    <engine>cosmos.v9</engine>
    <group>1244</group>
    <instanceType>c1.xlarge</instanceType>
    <keyName>cloud-key</keyName>
    <lastmodifieddate>-1909672168</lastmodifieddate>
    <maxInstances>0</maxInstances>
    <minInstances>0</minInstances>
    <parameters>
    <parameter key="myKey">myTestValue</parameter>
    </parameters>
    <queueLowerThreshold>0</queueLowerThreshold>
    <queueUpperThreshold>1</queueUpperThreshold>
    <securityGroup>default</securityGroup>
    <sqsQueuePrefix>testuser-nonscaling</sqsQueuePrefix>
    <userDataTemplateName>userdata.sh</userDataTemplateName>
    </item>
    <item id="251">
    <owner id="171">testuser</owner>
    <amiId>ami-d13cffb8</amiId>
    <availabilityzone>US-East-1a</availabilityzone>
    <concurrency>4</concurrency>
    <deleted>false</deleted>
    <engine>cosmos.v10</engine>
    <group>1244</group>
    <instanceType>m1.large</instanceType>
    <keyName>cloud-key</keyName>
    <lastmodifieddate>-1909671168</lastmodifieddate>
    <maxInstances>0</maxInstances>
    <minInstances>0</minInstances>
    <parameters/>
    <queueLowerThreshold>0</queueLowerThreshold>
    <queueUpperThreshold>1</queueUpperThreshold>
    <securityGroup>default</securityGroup>
    <sqsQueuePrefix>v10-6ebacc70-12ef-45d4-b18a-c6834a7dac49</sqsQueuePrefix>
    <userDataTemplateName>userdata.sh</userDataTemplateName>
    </item>
       .
       .
       .
    </Destination>

application/json

    {"item": [
    {
    "@id": "73",
    "owner":       {
    "@id": "171",
    "$": "testuser"
    },
    "amiId": "ami-01f33e68",
    "availabilityzone": "US-East-1a",
    "concurrency": "4",
    "deleted": "false",
    "engine": "cosmos.v9",
    "group": "1244",
    "instanceType": "c1.xlarge",
    "keyName": "cloud-key",
    "lastmodifieddate": "-1909672168",
    "maxInstances": "0",
    "minInstances": "0",
    "parameters": {"parameter":       {
    "@key": "myKey",
    "$": "myTestValue"
    }},
    "queueLowerThreshold": "0",
    "queueUpperThreshold": "1",
    "securityGroup": "default",
    "sqsQueuePrefix": "testuser-nonscaling",
    "userDataTemplateName": "userdata.sh"
    },
    {
    "@id": "250",
    "owner":       {
    "@id": "171",
    "$": "testuser"
    },
    "amiId": "ami-d13cffb8",
    "availabilityzone": "US-East-1a",
    "concurrency": "4",
    "deleted": "false",
    "engine": "cosmos.v10",
    "group": "1244",
    "instanceType": "m1.large",
    "keyName": "cloud-key",
    "lastmodifieddate": "-1909671168",
    "maxInstances": "0",
    "minInstances": "0",
    "parameters": null,
    "queueLowerThreshold": "0",
    "queueUpperThreshold": "1",
    "securityGroup": "default",
    "sqsQueuePrefix": "v10-973bc6de-8903-47ff-a634-c06f8e45197b",
    "userDataTemplateName": "userdata.sh"
    }
    ]}

text/xml

    <Destination>
    <item id="73">
    <owner id="171">testuser</owner>
    <amiId>ami-01f33e68</amiId>
    <availabilityzone>US-East-1a</availabilityzone>
    <concurrency>4</concurrency>
    <deleted>false</deleted>
    <engine>cosmos.v9</engine>
    <group>1244</group>
    <instanceType>c1.xlarge</instanceType>
    <keyName>cloud-key</keyName>
    <lastmodifieddate>-1909672168</lastmodifieddate>
    <maxInstances>0</maxInstances>
    <minInstances>0</minInstances>

    <parameters>
    <parameter key="myKey">myTestValue</parameter>
    </parameters>
    <queueLowerThreshold>0</queueLowerThreshold>
    <queueUpperThreshold>1</queueUpperThreshold>
    <securityGroup>default</securityGroup>
    <sqsQueuePrefix>testuser-nonscaling</sqsQueuePrefix>
    <userDataTemplateName>userdata.sh</userDataTemplateName>
    </item>

    <item id="251">
    <owner id="171">testuser</owner>
    <amiId>ami-d13cffb8</amiId>
    <availabilityzone>US-East-1a</availabilityzone>
    <concurrency>4</concurrency>
    <deleted>false</deleted>
    <engine>cosmos.v10</engine>
    <group>1244</group>
    <instanceType>m1.large</instanceType>
    <keyName>cloud-key</keyName>
    <lastmodifieddate>-1909671168</lastmodifieddate>
    <maxInstances>0</maxInstances>
    <minInstances>0</minInstances>
    <parameters/>
    <queueLowerThreshold>0</queueLowerThreshold>
    <queueUpperThreshold>1</queueUpperThreshold>
    <securityGroup>default</securityGroup>
    <sqsQueuePrefix>v10-6ebacc70-12ef-45d4-b18a-c6834a7dac49</sqsQueuePrefix>
    <userDataTemplateName>userdata.sh</userDataTemplateName>
    </item>
       .
       .
       .
    </Destination>

 

findDestination

Return a destination by id

Parameters

Name Type Description
id
Long
id of the destination to return
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/destination/74?s=49bfe32d-df30-4797-a8b1-96da5c1b5609

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/destination/74?s=49bfe32d-df30-4797-a8b1-96da5c1b5609 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 18:58:45 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

application/xml

    <Destination id="74" xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <owner id="171">testuser</owner>
    <amiId>ami-01f33e68</amiId>
    <availabilityzone>US-East-1a</availabilityzone>
    <concurrency>4</concurrency>
    <deleted>false</deleted>
    <engine>cosmos.v9</engine>
    <group>1244</group>
    <instanceType>m1.small</instanceType>
    <keyName>cloud-key</keyName>
    <lastmodifieddate>-1909672168</lastmodifieddate>
    <maxInstances>0</maxInstances>
    <minInstances>0</minInstances>
    <parameters/>
    <queueLowerThreshold>0</queueLowerThreshold>
    <queueUpperThreshold>1</queueUpperThreshold>
    <securityGroup>default</securityGroup>
    <sqsQueuePrefix>default-testuser</sqsQueuePrefix>
    <userDataTemplateName>userdata.sh</userDataTemplateName>
    </Destination>

application/json

    {
       "@id": "74",
       "owner":    {
          "@id": "171",
          "$": "testuser"
       },
       "amiId": "ami-01f33e68",
       "availabilityzone": "US-East-1a",
       "concurrency": "4",
       "deleted": "false",
       "engine": "cosmos.v9",
       "group": "1244",
       "instanceType": "m1.small",
       "keyName": "cloud-key",
       "lastmodifieddate": "-1909672168",
       "maxInstances": "0",
       "minInstances": "0",
       "parameters": null,
       "queueLowerThreshold": "0",
       "queueUpperThreshold": "1",
       "securityGroup": "default",
       "sqsQueuePrefix": "default-testuser",
       "userDataTemplateName": "userdata.sh"
    }

text/xml

    <Destination id="74">
    <owner id="171">testuser</owner>
    <amiId>ami-01f33e68</amiId>
    <availabilityzone>US-East-1a</availabilityzone>
    <concurrency>4</concurrency>
    <deleted>false</deleted>
    <engine>cosmos.v9</engine>
    <group>1244</group>
    <instanceType>m1.small</instanceType>
    <keyName>cloud-key</keyName>
    <lastmodifieddate>-1909672168</lastmodifieddate>
    <maxInstances>0</maxInstances>
    <minInstances>0</minInstances>
    <parameters/>
    <queueLowerThreshold>0</queueLowerThreshold>
    <queueUpperThreshold>1</queueUpperThreshold>
    <securityGroup>default</securityGroup>
    <sqsQueuePrefix>default-testuser</sqsQueuePrefix>
    <userDataTemplateName>userdata.sh</userDataTemplateName>
    </Destination>

 

editDestination

Edit a Destination associated with a user.

Parameters

Name Type Description
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
POST

Example

Request

Header

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/destination?s=49bfe32d-df30-4797-a8b1-96da5c1b5609

    POST https://datacloud2.pervasive.com/EntityAPIService/REST/destination?s=49bfe32d-df30-4797-a8b1-96da5c1b5609 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 801

Body

    <Destination id="74" xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <owner id="171">testuser</owner>
    <amiId>ami-01f33e68</amiId>
    <availabilityzone>US-East-1a</availabilityzone>
    <concurrency>4</concurrency>
    <deleted>false</deleted>
    <engine>cosmos.v9</engine>
    <group>1244</group>
    <instanceType>m1.small</instanceType>
    <keyName>cloud-key</keyName>
    <lastmodifieddate>-1909672168</lastmodifieddate>
    <maxInstances>0</maxInstances>
    <minInstances>0</minInstances>
    <parameters/>
    <queueLowerThreshold>0</queueLowerThreshold>
    <queueUpperThreshold>1</queueUpperThreshold>
    <securityGroup>default</securityGroup>
    <sqsQueuePrefix>default-testuser</sqsQueuePrefix>
    <userDataTemplateName>userdata.sh</userDataTemplateName>
    </Destination>

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 18:58:45 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

putDestinationFile

Upload a file associated with a Destination.

Parameters

Name Type Description
destinationid
Long
the id of the Destination
filename
String
name of the file to upload
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
PUT

Example

Request

Header

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/destination/74/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt

    PUT https://datacloud2.pervasive.com/EntityAPIService/REST/destination/74/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/octet-stream
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 124

application/octet-stream

    This is the content of a sample file named sampleFile.txt
    Second line of the sample file content.
    End of the Sample content

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 19:08:56 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

getDestinationFile

Download a file associated with a Destination.

Parameters

Name Type Description
destinationid
Long
the id of the Destination
filename
String
name of the file to download
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/destination/74/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/destination/74/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/octet-stream
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    content-disposition: attachment; filename=sampleFile.txt
    Content-Type: application/octet-stream
    Date: Thu, 10 Nov 2011 19:12:55 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 124

    Connection: keep-alive

application/octet-stream

    This is the content of a sample file named sampleFile.txt
    Second line of the sample file content.
    End of the Sample content

 

deleteDestinationFile

Delete a file associated with a Destination.

Parameters

Name Type Description
destinationid
Long
the id of the Destination
filename
String
name of the file to delete
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
DELETE

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/destination/74/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt

    DELETE https://datacloud2.pervasive.com/EntityAPIService/REST/destination/74/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 19:16:03 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

startExecution

Start an execution referenced by id.

Parameters

Name Type Description
executionid
String
id of the execution to start
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
POST

Example

Request

    Url:https://datacloud2.pervasive.com/EntityAPIService/REST/execution/ff893b0e-1dee-44f7-94dc-937afd837595/start?s=45495b9d-4228-4d98-9997-d3c353fb3ff1

    POST https://datacloud2.pervasive.com/EntityAPIService/REST/execution/ff893b0e-1dee-44f7-94dc-937afd837595/start?s=45495b9d-4228-4d98-9997-d3c353fb3ff1 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 0

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Wed, 16 Nov 2011 10:49:03 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

stopExecution

Stop an execution referenced by id.

Parameters

Name Type Description
executionid
String
id of the execution to stop
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
POST

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/execution/ff893b0e-1dee-44f7-94dc-937afd837595/stop?s=45495b9d-4228-4d98-9997-d3c353fb3ff1

    POST https://datacloud2.pervasive.com/EntityAPIService/REST/execution/ff893b0e-1dee-44f7-94dc-937afd837595/stop?s=45495b9d-4228-4d98-9997-d3c353fb3ff1 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 0

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Wed, 16 Nov 2011 10:54:49 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

listExecutions

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

Parameters

Name Type Description
start
Integer
0-indexed ordinal of the first record to return
max
Integer
the maximum number of records to return
provisioningid
Long
the unique id of the provisioning
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/execution?max=5&start=0&s=49bfe32d-df30-4797-a8b1-96da5c1b5609&provisioningid=12349

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/execution?max=5&start=0&s=49bfe32d-df30-4797-a8b1-96da5c1b5609&provisioningid=12349 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 20:40:29 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 2317

    Connection: keep-alive

application/xml

    <Execution xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <item id="4daedca2-41f4-45e8-bc87-687c92ae0518">
    <owner id="171">testuser</owner>
    <currentTime>2011-11-10T20:40:29.412Z</currentTime>
    <parameters>
    <parameter secure="true" key="key"/>
    </parameters>
    <provisioning>12349</provisioning>
    <scheduledTime>2011-11-10T16:06:45.095Z</scheduledTime>
    </item>
       .
       .
       .
    </Execution>

application/json

    {"item": [
    {
    "@id": "4daedca2-41f4-45e8-bc87-687c92ae0518",
    "owner":       {
    "@id": "171",
    "$": "testuser"
    },
    "currentTime": "2011-11-10T20:42:22.042Z",
    "parameters": {"parameter":       {
    "@secure": "true",
    "@key": "key"
    }},
    "provisioning": "12349",
    "scheduledTime": "2011-11-10T16:06:45.095Z"
    },
    {
    "@id": "89d594c5-132c-4e53-8064-d592c31592dd",
    "owner":       {
    "@id": "171",
    "$": "testuser"
    },
    "currentTime": "2011-11-10T20:42:22.046Z",
    "finishTime": "2011-10-20T12:39:56.589Z",
    "logFile": "provisioning/12349/log/89d594c5-132c-4e53-8064-d592c31592dd",
    "parameters": null,
    "provisioning": "12349",
    "scheduledTime": "2011-10-20T12:33:39.433Z",
    "server": "ip-10-84-67-142.ec2.internal",
    "startTime": "2011-10-20T12:36:21.042Z"
    }
    ]}

text/xml

    <Execution>
    <item id="4daedca2-41f4-45e8-bc87-687c92ae0518">
    <owner id="171">testuser</owner>
    <currentTime>2011-11-10T20:40:30.668Z</currentTime>
    <parameters>
    <parameter secure="true" key="key"/>
    </parameters>
    <provisioning>12349</provisioning>
    <scheduledTime>2011-11-10T16:06:45.095Z</scheduledTime>
    </item>
       .
       .
       .
    </Execution>

 

findExecution

Return an execution by id.

Parameters

Name Type Description
id
String
id of the execution to return
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/execution/4daedca2-41f4-45e8-bc87-687c92ae0518?s=49bfe32d-df30-4797-a8b1-96da5c1b5609

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/execution/4daedca2-41f4-45e8-bc87-687c92ae0518?s=49bfe32d-df30-4797-a8b1-96da5c1b5609 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 20:46:56 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 418

    Connection: keep-alive

application/xml

    <Execution id="4daedca2-41f4-45e8-bc87-687c92ae0518" xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <owner id="171">testuser</owner>
    <currentTime>2011-11-10T20:46:56.710Z</currentTime>
    <parameters>
    <parameter secure="true" key="key"/>
    </parameters>
    <provisioning>12349</provisioning>
    <scheduledTime>2011-11-10T16:06:45.095Z</scheduledTime>
    </Execution>

application/json

    {
       "@id": "4daedca2-41f4-45e8-bc87-687c92ae0518",
       "owner":    {
          "@id": "171",
          "$": "testuser"
       },
       "currentTime": "2011-11-10T20:51:31.341Z",
       "parameters": {"parameter":    {
          "@secure": "true",
          "@key": "key"
       }},
       "provisioning": "12349",
       "scheduledTime": "2011-11-10T16:06:45.095Z"
    }

text/xml

    <Execution id="4daedca2-41f4-45e8-bc87-687c92ae0518">
    <owner id="171">testuser</owner>
    <currentTime>2011-11-10T20:46:58.656Z</currentTime>
    <parameters>
    <parameter secure="true" key="key"/>
    </parameters>
    <provisioning>12349</provisioning>
    <scheduledTime>2011-11-10T16:06:45.095Z</scheduledTime>
    </Execution>

 

createExecution

Create an execution object in preparation for job execution.

Parameters

Name Type Description
provisioningid
Long
the unique id of the provisioning
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
PUT

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/execution?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&provisioningid=12349

    PUT https://datacloud2.pervasive.com/EntityAPIService/REST/execution?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&provisioningid=12349 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 0

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 21:06:00 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

editExecution

Edit an execution object that has not yet been started.

Parameters

Name Type Description
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
POST

Example

Request
Header

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/execution?s=49bfe32d-df30-4797-a8b1-96da5c1b5609

    POST https://datacloud2.pervasive.com/EntityAPIService/REST/execution?s=49bfe32d-df30-4797-a8b1-96da5c1b5609 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: text/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 137

Body

    <Execution id="88039b65-33dd-470f-b721-4d883305c085">
    <parameters>
    <parameter key='mykey1'>myvalue</parameter>
    </parameters>
    </Execution>

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 21:02:39 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

putExecutionFile

Upload a file associated with an Execution.

Parameters

Name Type Description
executionid
String
id of the Execution
filename
String
name of the file to upload
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
PUT

Example

Request
Header

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/execution/88039b65-33dd-470f-b721-4d883305c085/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt

    PUT https://datacloud2.pervasive.com/EntityAPIService/REST/execution/88039b65-33dd-470f-b721-4d883305c085/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/octet-stream
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 124

application/octet-stream

    This is the content of a sample file named sampleFile.txt
    Second line of the sample file content.
    End of the Sample content

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 21:11:00 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

getExecutionFile

Download a file associated with an Execution.

Parameters

Name Type Description
executionid
String
id of the Execution
filename
String
name of the file to Download
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/execution/88039b65-33dd-470f-b721-4d883305c085/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/execution/88039b65-33dd-470f-b721-4d883305c085/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/octet-stream
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    content-disposition: attachment; filename=sampleFile.txt
    Content-Type: application/octet-stream
    Date: Thu, 10 Nov 2011 21:14:01 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 124

    Connection: keep-alive

application/octet-stream

    This is the content of a sample file named sampleFile.txt
    Second line of the sample file content.
    End of the Sample content

 

deleteExecutionFile

Delete a file associated with a Execution.

Parameters

Name Type Description
executionid
String
id of the Execution
filename
String
name of the file to delete
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
DELETE

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/execution/88039b65-33dd-470f-b721-4d883305c085/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt

    DELETE https://datacloud2.pervasive.com/EntityAPIService/REST/execution/88039b65-33dd-470f-b721-4d883305c085/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 21:16:21 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

runExecution

This call creates an execution and starts the execution in a single call.

Parameters

Name Type Description
provisioningid
Long
id of the Provisioning
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
POST

Example

Request

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 21:07:47 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 370

    Connection: keep-alive

 

listCredentials

List the credentials associated with the current user

Parameters

Name Type Description
start
Integer
0-indexed ordinal of the first record to return
max
Integer
the maximum number of records to return
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/credential?max=5&start=0&s=49bfe32d-df30-4797-a8b1-96da5c1b5609

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/credential?max=5&start=0&s=49bfe32d-df30-4797-a8b1-96da5c1b5609 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 20:19:11 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 1126

    Connection: keep-alive

application/xml

    <Credential xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <item id="2972028">
    <owner id="171">testuser</owner>
    <expiration>2031-09-23T20:51:33.933Z</expiration>
    <parameters>
    <parameter key="OAUTH_KEY">testValue</parameter>
    </parameters>
    <type>OAUTH_SESSION</type>
    </item>
       .
       .
       .
    </Credential>

application/json

    {"item": [
          {
          "@id": "2972028",
          "owner":       {
             "@id": "171",
             "$": "testuser"
          },
          "expiration": "2031-09-23T20:51:33.933Z",
          "parameters": {"parameter":       {
             "@key": "OAUTH_KEY",
             "$": "testValue"
          }},
          "type": "OAUTH_SESSION"
       },      
          {
          "@id": "3235281",
          "owner":       {
             "@id": "171",
             "$": "testuser"
          },
          "expiration": "2031-11-01T18:53:28.882Z",
          "parameters": {"parameter": {"@key": "sessionId"}},
          "type": "OAUTH_SESSION"
       }
    ]}

text/xml

    <Credential>
    <item id="2972028">
    <owner id="171">testuser</owner>
    <expiration>2031-09-23T20:51:33.933Z</expiration>
    <parameters>        
    <parameter key="OAUTH_KEY">testValue</parameter>
    </parameters>
    <type>OAUTH_SESSION</type>
    </item>
       .
       .
       .
    </Credential>

 

findCredential

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

Parameters

Name Type Description
id
Long
id of the credential to return
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/credential/2972028?s=49bfe32d-df30-4797-a8b1-96da5c1b5609

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/credential/2972028?s=49bfe32d-df30-4797-a8b1-96da5c1b5609 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 20:24:33 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 338
    Connection: keep-alive

application/xml

    <Credential id="2972028" xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <owner id="171">testuser</owner>
    <expiration>2031-09-23T20:51:33.933Z</expiration>
    <parameters>
    <parameter key="OAUTH_KEY">testValue</parameter>
    </parameters>
    <type>OAUTH_SESSION</type>
    </Credential>

application/json

    {
    "@id": "2972028",
    "owner":    {
    "@id": "171",
    "$": "testuser"
    },
    "expiration": "2031-09-23T20:51:33.933Z",
    "parameters": {"parameter":    {
    "@key": "OAUTH_KEY",
    "$": "testValue"
    }},
    "type": "OAUTH_SESSION"
    }

text/xml

    <Credential id="2972028">
    <owner id="171">testuser</owner>
    <expiration>2031-09-23T20:51:33.933Z</expiration>
    <parameters>
    <parameter key="OAUTH_KEY">testValue</parameter>
    </parameters>
    <type>OAUTH_SESSION</type>
    </Credential>

 

editCredential

Edit a credential associated with the user

Parameters

Name Type Description
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
POST

Example

Request
Header

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/credential?s=49bfe32d-df30-4797-a8b1-96da5c1b5609

    POST https://datacloud2.pervasive.com/EntityAPIService/REST/credential?s=49bfe32d-df30-4797-a8b1-96da5c1b5609 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 194

Body

    <Credential id="2972028">
    <expiration>2011-04-23T01:01:25.500-04:00</expiration>
    <parameters>
    <parameter key="myKey">myValue</parameter>
    </parameters>
    <type>executionSession</type>
    </Credential>

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 20:28:34 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

putCredentialFile

Upload a file associated with a Credential.

Parameters

Name Type Description
credentialid
Long
the id of the credential
filename
String
filename of the file
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
PUT

Example

Request
Header

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/credential/2972028/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt

    PUT https://datacloud2.pervasive.com/EntityAPIService/REST/credential/2972028/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/octet-stream
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 124

application/octet-stream

    This is the content of a sample file named sampleFile.txt
    Second line of the sample file content.
    End of the Sample content

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 20:32:31 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

getCredentialFile

Download a file associated with a Credential.

Parameters

Name Type Description
credentialid
Long
the id of the credential
filename
String
filename to download
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/credential/2972028/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/credential/2972028/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/octet-stream
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    content-disposition: attachment; filename=sampleFile.txt
    Content-Type: application/octet-stream
    Date: Thu, 10 Nov 2011 20:36:22 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 124
    Connection: keep-alive

application/octet-stream

    This is the content of a sample file named sampleFile.txt
    Second line of the sample file content.
    End of the Sample content

 

deleteCredentialFile

Delete a file associated with a Credential.

Parameters

Name Type Description
credentialid
Long
the id of the credential
filename
String
filename to delete
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
DELETE

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/credential/2972028/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt

    DELETE https://datacloud2.pervasive.com/EntityAPIService/REST/credential/2972028/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/octet-stream
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Wed, 16 Nov 2011 13:15:41 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

listUsers

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

Parameters

Name Type Description
start
Integer
0-indexed ordinal of the first record to return
max
Integer
the maximum number of records to return
sessionId
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/user?max=1&start=0&s=49bfe32d-df30-4797-a8b1-96da5c1b5609

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/user?max=1&start=0&s=49bfe32d-df30-4797-a8b1-96da5c1b5609 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 21:20:02 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 460
    Connection: keep-alive

application/xml

    <User xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <item id="171">
    <account>2708</account>
    <active>true</active>
    <administrator>true</administrator>
    <deleted>false</deleted>
    <lastmodifieddate>-1909755168</lastmodifieddate>
    <name>testuser</name>
    <parameters>
    <parameter secure="true" key="key"/>
    </parameters>
    <superUser>false</superUser>
    <temporarypassword>false</temporarypassword>
    </item>
    </User>

application/json

    {"item": {
    "@id": "171",
    "account": "2708",
    "active": "true",
    "administrator": "true",
    "deleted": "false",
    "lastmodifieddate": "-1909755168",
    "name": "testuser",
    "parameters": {"parameter":    {
    "@secure": "true",
    "@key": "key"
    }},
    "superUser": "false",
    "temporarypassword": "false"
    }}

text/xml

    <User>
    <item id="171">
    <account>2708</account>
    <active>true</active>
    <administrator>true</administrator>
    <deleted>false</deleted>
    <lastmodifieddate>-1909755168</lastmodifieddate>
    <name>testuser</name>
    <parameters>
    <parameter secure="true" key="key"/>
    </parameters>
    <superUser>false</superUser>
    <temporarypassword>false</temporarypassword>
    </item>
    </User>

 

findUser

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

Parameters

Name Type Description
id
Long
id of the user to return
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/user/171?s=49bfe32d-df30-4797-a8b1-96da5c1b5609

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/user/171?s=49bfe32d-df30-4797-a8b1-96da5c1b5609 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 21:22:49 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 447
    Connection: keep-alive

application/xml

    <User id="171" xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <account>2708</account>
    <active>true</active>
    <administrator>true</administrator>
    <deleted>false</deleted>
    <lastmodifieddate>-1909755168</lastmodifieddate>
    <name>testuser</name>
    <parameters>
    <parameter secure="true" key="key"/>
    </parameters>
    <superUser>false</superUser>
    <temporarypassword>false</temporarypassword>
    </User>

application/json

    {
       "@id": "171",
       "account": "2708",
       "active": "true",
       "administrator": "true",
       "deleted": "false",
       "lastmodifieddate": "-1909755168",
       "name": "testuser",
       "parameters": {"parameter":    {
          "@secure": "true",
          "@key": "key"
       }},
       "superUser": "false",
       "temporarypassword": "false"
    }

text/xml

    <User id="171">
    <account>2708</account>
    <active>true</active>
    <administrator>true</administrator>
    <deleted>false</deleted>
    <lastmodifieddate>-1909755168</lastmodifieddate>
    <name>testuser</name>
    <parameters>
    <parameter secure="true" key="key"/>
    </parameters>
    <superUser>false</superUser>
    <temporarypassword>false</temporarypassword>
    </User>

 

editUser

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

Parameters

Name Type Description
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
POST

Example

Request

Header

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/user?s=49bfe32d-df30-4797-a8b1-96da5c1b5609

    POST https://datacloud2.pervasive.com/EntityAPIService/REST/user?s=49bfe32d-df30-4797-a8b1-96da5c1b5609 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: */*
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 597

Body

    <User id="171">
    <name>testuser</name>
    <parameters>
    <parameter key="membership.company">Testing</parameter>
    <parameter key="membership.firstname">Test</parameter>
    <parameter key="awsSecretKey">9jY7cT605V4R3vdWJb3Ra+XbVXLwi7fYzum4fxKa</parameter>
    <parameter key="membership.email">testing@testing.com</parameter>
    <parameter key="membership.lastname">User</parameter>
    <parameter key="userkey">uservalue</parameter>
    <parameter key="membership.phone">123-456-789</parameter>
    <parameter key="awsAccessKey">AKIAIGM4XXTMW3BYABPA</parameter>
    <parameter key="mykey">myValue</parameter>
    </parameters>
    </User>

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 21:28:05 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

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
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
PUT

Example

Request
Header

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/user/171/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt

    PUT https://datacloud2.pervasive.com/EntityAPIService/REST/user/171/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/octet-stream
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 362

application/octet-stream

    <application xmlns="http://wadl.dev.java.net/2009/02">
    <doc xml:lang="en" title="login"/>
    <resources base="https://datacloud2.pervasive.com">
    <resource path="EntityAPIService/REST/postget/login" id="login">
    <doc xml:lang="en" title="login"/>
    <method name="GET" id="Method 1">
    <doc xml:lang="en" title="Method 1"/>
    <request/>
    </method>
    </resource>
    </resources>
    </application>

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 21:30:29 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

getUserFile

Download a file associated with a User.

Parameters

Name Type Description
userid
Long
id of the User
filename
String
filename to download
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/user/171/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/user/171/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1

    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 21:32:28 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

application/octet-stream

    This is the content of a sample file named sampleFile.txt
    Second line of the sample file content.
    End of the Sample content

 

deleteUserFile

Delete a file associated with a user.

Parameters

Name Type Description
userid
Long
id of the User
filename
String
name of the file to delete
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
DELETE

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/user/171/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt

    DELETE https://datacloud2.pervasive.com/EntityAPIService/REST/user/171/file?s=49bfe32d-df30-4797-a8b1-96da5c1b5609&filename=sampleFile.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1

    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Date: Mon, 31 Oct 2011 09:13:47 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Type: application/xml
    Content-Length: 0
    Connection: keep-alive

 

logout

Logout and terminate the API session

Parameters

Name Type Description
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/logout?s=49bfe32d-df30-4797-a8b1-96da5c1b5609

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/logout?s=49bfe32d-df30-4797-a8b1-96da5c1b5609 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Date: Tue, 05 Apr 2011 05:20:23 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Type: application/xml
    Content-Length: 0
    Connection: close

 

Errors

Following are the typical errors encountered during the RESTful calls

 

PostGet API RESTful WebService

PostGet API WebService enables the deployment and management of Web based data services provided by Pervasive DataCloud. The resources exposed by this RESTful WebService API allows CRUD operations on DataCloud Entities like Product/Integration, Provisioning/RuntimeConfiguration, etc. using HTTP methods GET and POST only. This document lists all these resources with their right usage. Also sample Request and Response are provided for each resource.

Note: Use this API only if there is client side restrictions on the usage of HTTP methods PUT and DELETE. Else use the CloudRest API which supports all the HTTP methods.

Refer to this document for a general overview on DataCloud Entities

http://cloud.pervasive.com/Technical/CloudUsersGuide/PervasiveDataCloud2APIDocumentation.aspx

 

login

Login and start a session with the below mentioned resource. The provided username and password combination is authenticated against pervasive membership service and a SessionId is returned. This sessionid is to be used in all subsequent REST calls, either in the form of 'sessionid' cookie or as query parameter 's'

Parameters

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

Methods

Name
POST

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/login

    POST https://datacloud2.pervasive.com/EntityAPIService/REST/postget/login HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 43

    username=testuser&password=mypass

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 10:40:41 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    Set-Cookie: sessionid=68af35d3-4a67-4bfc-ac46-5d5b6d7cbd46;Version=1
    X-Powered-By: Servlet/2.5
    Content-Length: 260
    Connection: keep-alive

application/xml

    <LoginResult>
    <message>Login successful</message>
    <sessionId>68af35d3-4a67-4bfc-ac46-5d5b6d7cbd46</sessionId>
    <success>true</success>
    <visitorKey>b40621ff-4af1-41bd-9033-f66899ea1695</visitorKey>
    </LoginResult>

application/json

    {
    "message": "Login successful",
    "sessionId": "a78ad5b9-ce67-4496-80a7-14389ce72039",
    "success": "true",
    "visitorKey": "9b087af8-a1df-427b-aabb-9d5a5ec8de39"
    }

text/xml

    <LoginResult>
    <message>Login successful</message>
    <sessionId>55831f37-b4d0-4a32-b16c-81aa98386ab2</sessionId>
    <success>true</success>
    <visitorKey>1af84a6a-2c15-4e45-bb36-b4e76dfb80a3</visitorKey>
    </LoginResult>

 

loginAlternative

Login using alternative method. (GET instead of POST)

Parameters

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

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/login?username=testuser&password=mypass

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/postget/login?username=testuser&password=mypass HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 06:24:12 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    Set-Cookie: sessionid=3758d0d1-9036-482c-9404-934fa604925e;Version=1
    X-Powered-By: Servlet/2.5
    Content-Length: 260
    Connection: keep-alive

application/xml

    <LoginResult>
    <message>Login successful</message>
    <sessionId>3758d0d1-9036-482c-9404-934fa604925e</sessionId>
    <success>true</success>
    <visitorKey>74b54e87-100b-44ed-81e1-2b3e162b00ab</visitorKey>
    </LoginResult>

application/jason

    {
    "message": "Login successful",
    "sessionId": "aa0568d6-d591-43a3-959d-b7db6632ef3f",
    "success": "true",
    "visitorKey": "8d2c0580-e665-497c-9ff5-a9c53c147d39"
    }

text/xml

    <LoginResult>
    <message>Login successful</message>
    <sessionId>e1f536c7-baca-4268-a668-68ceba857a57</sessionId>
    <success>true</success>
    <visitorKey>c197d245-321e-414b-bd1a-87356e44acc5</visitorKey>
    </LoginResult>

 

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
start
Integer
0-indexed ordinal of the first record to return
max
Integer
the maximum number of records to return
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/product?max=1&start=0&s=3758d0d1-9036-482c-9404-934fa604925e

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/postget/product?max=1&start=0&s=3758d0d1-9036-482c-9404-934fa604925e HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 08:55:35 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 547
    Connection: keep-alive

application/xml

    <Product xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <item id="" permissions="">
    <owner id="171">testuser</owner>
    <active>false</active>
    <concurrent>false</concurrent>
    <deleted>false</deleted>
    <description>Sub Test</description>
    <destination>250</destination>
    <group>1244</group>
    <lastmodifieddate>-1909684168</lastmodifieddate>
    <name>Sub Test</name>
    <parameters/>
    <parentProvisioningId>15046</parentProvisioningId>
    <process/>
    <userProduct>true</userProduct>
    </item>
    </Product>

application/jason

    {"item": {
    "@id": "",
    "@permissions": "",
    "owner": {
    "@id": "171",
    "$": "testuser"
    },
    "active": "false",
    "concurrent": "false",
    "deleted": "false",
    "description": "Sub Test",
    "destination": "250",
    "group": "1244",
    "lastmodifieddate": "-1909684168",
    "name": "Sub Test",
    "parameters": null,
    "parentProvisioningId": "15046",
    "process": "",
    "userProduct": "true"
    }}

text/xml

    <Product>
    <item id="" permissions="">
    <owner id="171">testuser</owner>
    <active>false</active>
    <concurrent>false</concurrent>
    <deleted>false</deleted>
    <description>Sub Test</description>
    <destination>250</destination>
    <group>1244</group>
    <lastmodifieddate>-1909684168</lastmodifieddate>
    <name>Sub Test</name>
    <parameters/>
    <parentProvisioningId>15046</parentProvisioningId>
    <process/>
    <userProduct>true</userProduct>
    </item>
    </Product>

 

findProduct

Return a product by id.

Parameters

Name Type Description
sku
String
the id of the product to return
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/product/00c55ba1-2fcb-4109-aa73-8ff2aa8d4af9?s=3758d0d1-9036-482c-9404-934fa604925e

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/postget/product/00c55ba1-2fcb-4109-aa73-8ff2aa8d4af9?s=3758d0d1-9036-482c-9404-934fa604925e HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 09:50:59 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 752
    Connection: keep-alive

application/xml

    <Product id="00c55ba1-2fcb-4109-aa73-8ff2aa8d4af9" permissions="" xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <owner id="171">testuser</owner>
    <active>true</active>
    <concurrent>false</concurrent>
    <deleted>false</deleted>
    <description>PICCP Connector for MeS</description>
    <destination>73</destination>
    <group>1244</group>
    <lastmodifiedby>171</lastmodifiedby>
    <lastmodifieddate>-1909684168</lastmodifieddate>
    <name>PICCP MeS</name>
    <parameters>
    <parameter key="mykey2"/>
    <parameter key="ProviderID"/>
    <parameter key="ProviderConfig"/>
    </parameters>
    <parentProvisioningId>13351</parentProvisioningId>
    <process/>
    <userProduct>true</userProduct>
    </Product>

application/jason

    {
    "@id": "00c55ba1-2fcb-4109-aa73-8ff2aa8d4af9",
    "@permissions": "",
    "owner": {
    "@id": "171",
    "$": "testuser"
    },
    "active": "true",
    "concurrent": "false",
    "deleted": "false",
    "description": "PICCP Connector for MeS",
    "destination": "73",
    "group": "1244",
    "lastmodifiedby": "171",
    "lastmodifieddate": "-1909684168",
    "name": "PICCP MeS",
    "parameters": {"parameter": [
    {
    "@key": "mykey2",
    "$": ""
    },
    {
    "@key": "ProviderID",
    "$": ""
    },
    {
    "@key": "ProviderConfig",
    "$": ""
    }
    ]},
    "parentProvisioningId": "13351",
    "process": "",
    "userProduct": "true"
    }

text/xml

    <Product id="00c55ba1-2fcb-4109-aa73-8ff2aa8d4af9" permissions="">
    <owner id="171">testuser</owner>
    <active>true</active>
    <concurrent>false</concurrent>
    <deleted>false</deleted>
    <description>PICCP Connector for MeS</description>
    <destination>73</destination>
    <group>1244</group>
    <lastmodifiedby>171</lastmodifiedby>
    <lastmodifieddate>-1909684168</lastmodifieddate>
    <name>PICCP MeS</name>
    <parameters>
    <parameter key="mykey2"/>
    <parameter key="ProviderID"/>
    <parameter key="ProviderConfig"/>
    </parameters>
    <parentProvisioningId>13351</parentProvisioningId>
    <process/>
    <userProduct>true</userProduct>
    </Product>

 

editProduct

Edit a custom Product object associated with the user.

Parameters

Name Type Description
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
POST

Example

Request

Header

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/product?s=e1f536c7-baca-4268-a668-68ceba857a57

    POST https://datacloud2.pervasive.com/EntityAPIService/REST/postget/product?s=e1f536c7-baca-4268-a668-68ceba857a57 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 696

Body

    <Product id="00c55ba1-2fcb-4109-aa73-8ff2aa8d4af9" permissions="" xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <owner id="171">testuser</owner>
    <active>true</active>
    <concurrent>false</concurrent>
    <deleted>false</deleted>
    <description>PICCP Connector for MeS</description>
    <destination>73</destination>
    <group>132</group>
    <lastmodifieddate>-2076190168</lastmodifieddate>
    <name>PICCP MeS</name>
    <parameters>
    <parameter key="mykey2"/>
    <parameter key="ProviderID"/>
    <parameter key="ProviderConfig"/>
    </parameters>
    <parentProvisioningId>13351</parentProvisioningId>
    <process/>
    <userProduct>true</userProduct>
    </Product>

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 11:13:26 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

putProductFile

Upload a file associated with a Product.

Parameters

Name Type Description
productid
String
SKU of the Product
filename
String
name of the file to upload
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
POST

Example

Request
Header

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/product/00c55ba1-2fcb-4109-aa73-8ff2aa8d4af9/file?s=3758d0d1-9036-482c-9404-934fa604925e&filename=putp.txt

    POST https://datacloud2.pervasive.com/EntityAPIService/REST/postget/product/00c55ba1-2fcb-4109-aa73-8ff2aa8d4af9/file?s=3758d0d1-9036-482c-9404-934fa604925e&filename=putp.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/octet-stream
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 756

application/octet-stream

    <Product id="00c55ba1-2fcb-4109-aa73-8ff2aa8d4af9" permissions="" xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <owner id="171">testuser</owner>
    <active>true</active>
    <concurrent>false</concurrent>
    <deleted>false</deleted>
    <description>PICCP Connector for MeS</description>
    <destination>73</destination>
    <group>1244</group>
    <lastmodifiedby>171</lastmodifiedby>
    <lastmodifieddate>-1909684168</lastmodifieddate>
    <name>PICCP MeS</name>
    <parameters>
    <parameter key="mykey2"/>
    <parameter key="ProviderID"/>
    <parameter key="ProviderConfig"/> </parameters> <parentProvisioningId>13351</parentProvisioningId>
    <process/>
    <userProduct>true</userProduct>
    </Product>

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 09:52:29 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

getProductFile

Delete a file associated with a Product.

Parameters

Name Type Description
productid
String
SKU of the Product
filename
String
name of the file to download
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/product/00c55ba1-2fcb-4109-aa73-8ff2aa8d4af9/file?s=3758d0d1-9036-482c-9404-934fa604925e&filename=putp.txt

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/postget/product/00c55ba1-2fcb-4109-aa73-8ff2aa8d4af9/file?s=3758d0d1-9036-482c-9404-934fa604925e&filename=putp.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/octet-stream
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    content-disposition: attachment; filename=putp.txt
    Content-Type: application/octet-stream
    Date: Fri, 11 Nov 2011 09:53:13 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive


application/octet-stream

    This is the content of a sample file named putp.txt
    Second line of the sample file content.
    End of the Sample content

 

listProvisionings

List the provisionings associated with the current user.

Parameters

Name Type Description
start
Integer
0-indexed ordinal of the first record to return
max
Integer
the maximum number of records to return
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/provisioning?max=1&start=0&s=3758d0d1-9036-482c-9404-934fa604925e

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/postget/provisioning?max=1&start=0&s=3758d0d1-9036-482c-9404-934fa604925e HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/json
    Date: Fri, 11 Nov 2011 07:24:19 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    transfer-encoding: chunked
    Connection: keep-alive

application/xml

    <Provisioning xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <item id="12086" permissions="">
    <owner id="171">testuser</owner>
    <expirationDate>2010-06-25T04:00:00Z</expirationDate>
    <lastmodifiedby>171</lastmodifiedby>
    <parameters>
    <parameter key="mykey">myValue</parameter>
    </parameters>
    <product>IDSSSBV-E01W201-91900-01</product>
    <productOwnedId>a1730000000K26vAAC</productOwnedId>
    <user>171</user>
    </item>
    </Provisioning>

application/jason

    {"item": {
    "@id": "12086",
    "@permissions": "",
    "owner": {
    "@id": "171",
    "$": "testuser"
    },
    "expirationDate": "2010-06-25T04:00:00Z",
    "lastmodifiedby": "171",
    "parameters": {"parameter": {
    "@key": "mykey",
    "$": "myValue"
    }},
    "product": "IDSSSBV-E01W201-91900-01",
    "productOwnedId": "a1730000000K26vAAC",
    "user": "171"
    }}

text/xml

    <Provisioning>
    <item id="12086" permissions="">
    <owner id="171">testuser</owner>
    <expirationDate>2010-06-25T04:00:00Z</expirationDate>
    <lastmodifiedby>171</lastmodifiedby>
    <parameters>
    <parameter key="mykey">myValue</parameter>
    </parameters>
    <product>IDSSSBV-E01W201-91900-01</product>
    <productOwnedId>a1730000000K26vAAC</productOwnedId>
    <user>171</user>
    </item>
    </Provisioning>

 

findProvisioning

Return a provisioning by id.

Parameters

Name Type Description
id
Long
id of the provisioning to return
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/provisioning/12349?s=3758d0d1-9036-482c-9404-934fa604925e

GET https://datacloud2.pervasive.com/EntityAPIService/REST/postget/provisioning/12349?s=3758d0d1-9036-482c-9404-934fa604925e HTTP/1.1
Accept-Encoding: gzip,deflate
Accept: application/xml
User-Agent: Jakarta Commons-HttpClient/3.1
Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/json
    Date: Fri, 11 Nov 2011 14:11:32 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    transfer-encoding: chunked
    Connection: keep-alive

application/xml

    <Provisioning id="12349" permissions="" xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <owner id="171">testuser</owner>
    <expirationDate>2012-12-31T05:00:00Z</expirationDate>
    <lastmodifiedby>171</lastmodifiedby>
    <name>testprovivsioning</name>
    <parameters>
    <parameter secure="true" key="testparameterkey"/>
    </parameters>
    <process>sampleprocess</process>
    <product>IDSCREDL-E01W201-91900-01</product>
    <productOwnedId>a1730000000XgrEAAS</productOwnedId>
    <schedule>0</schedule>
    <startDate>2009-10-22T04:00:00Z</startDate>
    <user>171</user>
    </Provisioning>

application/jason

    {
    "@id": "12349",
    "@permissions": "",
    "owner": {
    "@id": "171",
    "$": "testuser"
    },
    "expirationDate": "2012-12-31T05:00:00Z",
    "lastmodifiedby": "171",
    "name": "testprovivsioning",
    "parameters": {"parameter": {
    "@secure": "true",
    "@key": "testparameterkey"
    }},
    "process": "sampleprocess",
    "product": "IDSCREDL-E01W201-91900-01",
    "productOwnedId": "a1730000000XgrEAAS",
    "schedule": "0",
    "startDate": "2009-10-22T04:00:00Z",
    "user": "171"
    }

text/xml

    <Provisioning id="12349" permissions="">
    <owner id="171">testuser</owner>
    <expirationDate>2012-12-31T05:00:00Z</expirationDate>
    <lastmodifiedby>171</lastmodifiedby>
    <name>testprovivsioning</name>
    <parameters>
    <parameter secure="true" key="testparameterkey"/>
    </parameters>
    <process>sampleprocess</process>
    <product>IDSCREDL-E01W201-91900-01</product>
    <productOwnedId>a1730000000XgrEAAS</productOwnedId>
    <schedule>0</schedule>
    <startDate>2009-10-22T04:00:00Z</startDate>
    <user>171</user>
    </Provisioning>

 

editProvisioning

Edit a provisioning associated with a user.

Parameters

Name Type Description
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
POST

Example

Request
Header

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/provisioning?s=e1f536c7-baca-4268-a668-68ceba857a57

    POST
    https://datacloud2.pervasive.com/EntityAPIService/REST/postget/provisioning?s=e1f536c7-baca-4268-a668-68ceba857a57 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 623

Body

    <Provisioning id="12349" permissions="" xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <owner id="171">testuser</owner>
    <expirationDate>2012-12-31T05:00:00Z</expirationDate>
    <lastmodifiedby>171</lastmodifiedby>
    <name>testprovivsioning</name>
    <parameters>
    <parameter secure="true" key="testparameterkey"/>
    </parameters>
    <process>sampleprocess</process>
    <product>IDSCREDL-E01W201-91900-01</product>
    <productOwnedId>a1730000000XgrEAAS</productOwnedId>
    <schedule>0</schedule>
    <startDate>2009-10-22T04:00:00Z</startDate>
    <user>171</user>
    </Provisioning>

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 11:18:11 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

putProvisioningFile

Upload a file associated with a Provisioning.

Parameters

Name Type Description
provisioningid
Long
id of the Provisioning
filename
String
name of the file to upload
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
POST

Example

Request
Header

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/provisioning/12349/file?s=3758d0d1-9036-482c-9404-934fa604925e&filename=putp.txt

    POST https://datacloud2.pervasive.com/EntityAPIService/REST/postget/provisioning/12349/file?s=3758d0d1-9036-482c-9404-934fa604925e&filename=putp.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/octet-stream
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 6

application/octet-stream

    <Provisioning id="12349" permissions="" xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <owner id="171">testuser</owner>
    <expirationDate>2012-12-31T05:00:00Z</expirationDate>
    <lastmodifiedby>171</lastmodifiedby>
    <name>testprovivsioning</name>
    <parameters>
    <parameter secure="true" key="testparameterkey"/>
    </parameters>
    <process>sampleprocess</process>
    <product>IDSCREDL-E01W201-91900-01</product>
    <productOwnedId>a1730000000XgrEAAS</productOwnedId>
    <schedule>0</schedule>
    <startDate>2009-10-22T04:00:00Z</startDate>
    <user>171</user>
    </Provisioning>

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 07:01:23 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

getProvisioningFile

Download a file associated with a Provisioning.

Parameters

Name Type Description
provisioningid
Long
id of the Provisioning
filename
String
name of the file to upload
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url:

    https://datacloud2.pervasive.com/EntityAPIService/REST/postget/provisioning/12349/file?s=3758d0d1-9036-482c-9404-934fa604925e&filename=putp.txt

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/postget/provisioning/12349/file?s=3758d0d1-9036-482c-9404-934fa604925e&filename=putp.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/octet-stream
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    content-disposition: attachment; filename=putp.txt
    Content-Type: application/octet-stream
    Date: Fri, 11 Nov 2011 07:21:23 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

application/octet-stream

    This is the content of a sample file named putp.txt
    Second line of the sample file content.
    End of the Sample content

 

getTypeParameter

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

Parameters

Name Type Description
entityType
String
name of the entitytype
id
Long
id of the entityType
name
String
the key of the parameter to return
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/provisioning/12349/parameter?name=mykey2&s=3758d0d1-9036-482c-9404-934fa604925e

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/postget/provisioning/12349/parameter?name=mykey2&s=3758d0d1-9036-482c-9404-934fa604925e HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: text/plain
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: text/plain; charset=UTF-8
    Date: Fri, 11 Nov 2011 10:07:05 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    transfer-encoding: chunked
    Connection: keep-alive

text/xml

    MyValue

 

putTypeParameter

post the value of a parameter associated with a entityType with referenced by id.

Parameters

Name Type Description
entityType
String
name of the entitytype
id
Long
id of the entityType
name
String
the key of the parameter to return
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
POST

Example

Request
Header

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/provisioning/12349/parameter?name=mykey2&s=3758d0d1-9036-482c-9404-934fa604925e

    POST https://datacloud2.pervasive.com/EntityAPIService/REST/postget/provisioning/12349/parameter?name=mykey2&s=3758d0d1-9036-482c-9404-934fa604925e HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: text/plain
    Content-Type: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 7

Body

    MyValue

Response

Header

    HTTP/1.1 200 OK
    Content-Type: text/plain; charset=UTF-8
    Date: Fri, 11 Nov 2011 10:07:02 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

listDestinations

List the destinations associated with the current user.

Parameters

Name Type Description
start
Integer
0-indexed ordinal of the first record to return
max
Integer
the maximum number of records to return
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/destination?max=1&start=0&s=3758d0d1-9036-482c-9404-934fa604925e

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/postget/destination?max=1&start=0&s=3758d0d1-9036-482c-9404-934fa604925e HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 07:50:21 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 857
    Connection: keep-alive

application/xml

    <Destination xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <item id="73">
    <owner id="171">testuser</owner>
    <amiId>ami-01f33e68</amiId>
    <availabilityzone>US-East-1a</availabilityzone>
    <concurrency>4</concurrency>
    <deleted>false</deleted>
    <engine>cosmos.v9</engine>
    <group>1244</group>
    <instanceType>c1.xlarge</instanceType>
    <keyName>cloud-key</keyName>
    <lastmodifieddate>-1909672168</lastmodifieddate>
    <maxInstances>0</maxInstances>
    <minInstances>0</minInstances>
    <parameters>
    <parameter key="myKey">myTestValue</parameter>
    </parameters>
    <queueLowerThreshold>0</queueLowerThreshold>
    <queueUpperThreshold>1</queueUpperThreshold>
    <securityGroup>default</securityGroup>
    <sqsQueuePrefix>testuser-nonscaling</sqsQueuePrefix>
    <userDataTemplateName>userdata.sh</userDataTemplateName>
    </item>
    </Destination>

application/jason

    {"item": {
    "@id": "73",
    "owner": {
    "@id": "171",
    "$": "testuser"
    },
    "amiId": "ami-01f33e68",
    "availabilityzone": "US-East-1a",
    "concurrency": "4",
    "deleted": "false",
    "engine": "cosmos.v9",
    "group": "1244",
    "instanceType": "c1.xlarge",
    "keyName": "cloud-key",
    "lastmodifieddate": "-1909672168",
    "maxInstances": "0",
    "minInstances": "0",
    "parameters": {"parameter": {
    "@key": "myKey",
    "$": "myTestValue"
    }},
    "queueLowerThreshold": "0",
    "queueUpperThreshold": "1",
    "securityGroup": "default",
    "sqsQueuePrefix": "testuser-nonscaling",
    "userDataTemplateName": "userdata.sh"
    }}

text/xml

    <Destination>
    <item id="73">
    <owner id="171">testuser</owner>
    <amiId>ami-01f33e68</amiId>
    <availabilityzone>US-East-1a</availabilityzone>
    <concurrency>4</concurrency>
    <deleted>false</deleted>
    <engine>cosmos.v9</engine>
    <group>1244</group>
    <instanceType>c1.xlarge</instanceType>
    <keyName>cloud-key</keyName>
    <lastmodifieddate>-1909672168</lastmodifieddate>
    <maxInstances>0</maxInstances>
    <minInstances>0</minInstances>
    <parameters>
    <parameter key="myKey">myTestValue</parameter>
    </parameters>
    <queueLowerThreshold>0</queueLowerThreshold>
    <queueUpperThreshold>1</queueUpperThreshold>
    <securityGroup>default</securityGroup>
    <sqsQueuePrefix>testuser-nonscaling</sqsQueuePrefix>
    <userDataTemplateName>userdata.sh</userDataTemplateName>
    </item>
    </Destination>

 

findDestination

Return a destination by id

Parameters

Name Type Description
id
Long
id of the destination to return
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/destination/73?s=3758d0d1-9036-482c-9404-934fa604925e

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/postget/destination/73?s=3758d0d1-9036-482c-9404-934fa604925e HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 07:54:12 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 844
    Connection: keep-alive

application/xml

    <Destination id="73" xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <owner id="171">testuser</owner>
    <amiId>ami-01f33e68</amiId>
    <availabilityzone>US-East-1a</availabilityzone>
    <concurrency>4</concurrency>
    <deleted>false</deleted>
    <engine>cosmos.v9</engine>
    <group>1244</group>
    <instanceType>c1.xlarge</instanceType>
    <keyName>cloud-key</keyName>
    <lastmodifieddate>-1909672168</lastmodifieddate>
    <maxInstances>0</maxInstances>
    <minInstances>0</minInstances>
    <parameters>
    <parameter key="myKey">myTestValue</parameter>
    </parameters>
    <queueLowerThreshold>0</queueLowerThreshold>
    <queueUpperThreshold>1</queueUpperThreshold>
    <securityGroup>default</securityGroup>
    <sqsQueuePrefix>testuser-nonscaling</sqsQueuePrefix>
    <userDataTemplateName>userdata.sh</userDataTemplateName>
    </Destination>

application/jason

    {
    "@id": "73",
    "owner": {
    "@id": "171",
    "$": "testuser"
    },
    "amiId": "ami-01f33e68",
    "availabilityzone": "US-East-1a",
    "concurrency": "4",
    "deleted": "false",
    "engine": "cosmos.v9",
    "group": "1244",
    "instanceType": "c1.xlarge",
    "keyName": "cloud-key",
    "lastmodifieddate": "-1909672168",
    "maxInstances": "0",
    "minInstances": "0",
    "parameters": {"parameter": {
    "@key": "myKey",
    "$": "myTestValue"
    }},
    "queueLowerThreshold": "0",
    "queueUpperThreshold": "1",
    "securityGroup": "default",
    "sqsQueuePrefix": "testuser-nonscaling",
    "userDataTemplateName": "userdata.sh"
    }

text/xml

    <Destination id="73">
    <owner id="171">testuser</owner>
    <amiId>ami-01f33e68</amiId>
    <availabilityzone>US-East-1a</availabilityzone>
    <concurrency>4</concurrency>
    <deleted>false</deleted>
    <engine>cosmos.v9</engine>
    <group>1244</group>
    <instanceType>c1.xlarge</instanceType>
    <keyName>cloud-key</keyName>
    <lastmodifieddate>-1909672168</lastmodifieddate>
    <maxInstances>0</maxInstances>
    <minInstances>0</minInstances>
    <parameters>
    <parameter key="myKey">myTestValue</parameter>
    </parameters>
    <queueLowerThreshold>0</queueLowerThreshold>
    <queueUpperThreshold>1</queueUpperThreshold>
    <securityGroup>default</securityGroup>
    <sqsQueuePrefix>testuser-nonscaling</sqsQueuePrefix>
    <userDataTemplateName>userdata.sh</userDataTemplateName>
    </Destination>

 

editDestination

Edit a Destination associated with a user.

Parameters

Name Type Description
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
POST

Example

Request

Header

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/destination?s=e1f536c7-baca-4268-a668-68ceba857a57

    POST
    https://datacloud2.pervasive.com/EntityAPIService/REST/postget/destination?s=e1f536c7-baca-4268-a668-68ceba857a57&sessionid=e1f536c7-baca-4268-a668-68ceba857a57 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 894

Body

    <Destination id="73" xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <owner id="171">testuser</owner>
    <amiId>ami-01f33e68</amiId>
    <availabilityzone>US-East-1a</availabilityzone>
    <concurrency>4</concurrency>
    <deleted>false</deleted>
    <engine>cosmos.v9</engine>
    <group>1244</group>
    <instanceType>c1.xlarge</instanceType>
    <keyName>cloud-key</keyName>
    <lastmodifieddate>-1909672168</lastmodifieddate>
    <maxInstances>0</maxInstances>
    <minInstances>0</minInstances>
    <parameters>
    <parameter key="myKey">myTestValue</parameter>
    </parameters>
    <queueLowerThreshold>0</queueLowerThreshold>
    <queueUpperThreshold>1</queueUpperThreshold>
    <securityGroup>default</securityGroup>
    <sqsQueuePrefix>testuser-nonscaling</sqsQueuePrefix>
    <userDataTemplateName>userdata.sh</userDataTemplateName>
    </Destination>

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 11:02:57 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

putDestinationFile

Upload a file associated with a Destination.

Parameters

Name Type Description
destinationid
Long
the id of the Destination
filename
String
name of the file to upload
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
POST

Example

Request

Header

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/destination/73/file?s=3758d0d1-9036-482c-9404-934fa604925e&filename=putd.txt

    POST
    https://datacloud2.pervasive.com/EntityAPIService/REST/postget/destination/73/file?s=3758d0d1-9036-482c-9404-934fa604925e&filename=putd.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/octet-stream
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 873

application/octet-stream

    <Destination id="73" xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <owner id="171">testuser</owner>
    <amiId>ami-01f33e68</amiId>
    <availabilityzone>US-East-1a</availabilityzone>
    <concurrency>4</concurrency>
    <deleted>false</deleted>
    <engine>cosmos.v9</engine>
    <group>1244</group>
    <instanceType>c1.xlarge</instanceType>
    <keyName>cloud-key</keyName>
    <lastmodifieddate>-1909672168</lastmodifieddate>
    <maxInstances>0</maxInstances>
    <minInstances>0</minInstances>
    <parameters>
    <parameter key="myKey">myTestValue</parameter>
    </parameters>
    <queueLowerThreshold>0</queueLowerThreshold>
    <queueUpperThreshold>1</queueUpperThreshold>
    <securityGroup>default</securityGroup>
    <sqsQueuePrefix>testuser-nonscaling</sqsQueuePrefix>
    <userDataTemplateName>userdata.sh</userDataTemplateName>
    </Destination>

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 07:59:05 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

getDestinationFile

Download a file associated with a Destination.

Parameters

Name Type Description
destinationid
Long
the id of the Destination
filename
String
name of the file to download
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/destination/74/file?s=3758d0d1-9036-482c-9404-934fa604925e&filename=putd.txt

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/postget/destination/74/file?s=3758d0d1-9036-482c-9404-934fa604925e&filename=putd.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/octet-stream
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    content-disposition: attachment; filename=putd.txt
    Content-Type: application/octet-stream
    Date: Fri, 11 Nov 2011 08:02:28 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

application/octet-stream

    This is the content of a sample file named putd.txt
    Second line of the sample file content.
    End of the Sample content

 

startExecution

Start an execution referenced by id.

Parameters

Name Type Description
executionid
String
id of the execution to start
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
POST

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/execution/89d594c5-132c-4e53-8064-d592c31592dd/start?s=3758d0d1-9036-482c-9404-934fa604925e

    POST https://datacloud2.pervasive.com/EntityAPIService/REST/postget/execution/89d594c5-132c-4e53-8064-d592c31592dd/start?s=3758d0d1-9036-482c-9404-934fa604925e HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 0

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 10:21:10 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

listExecutions

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

Parameters

Name Type Description
start
Integer
0-indexed ordinal of the first record to return
max
Integer
the maximum number of records to return
provisioningid
Long
the unique id of the provisioning
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/execution?max=1&start=0&s=3758d0d1-9036-482c-9404-934fa604925e&provisioningid=12349

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/postget/execution?max=1&start=0&s=3758d0d1-9036-482c-9404-934fa604925e&provisioningid=12349 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 10:13:19 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 604
    Connection: keep-alive

application/xml

    <Execution xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <item id="1fb013d7-7cd2-479e-bf59-3e1216eec920">
    <owner id="171">testuser</owner>
    <currentTime>2011-11-11T10:13:19.707Z</currentTime>
    <finishTime>2011-11-10T23:00:10.905Z</finishTime>
    <logFile>provisioning/12349/log/1fb013d7-7cd2-479e-bf59-3e1216eec920</logFile>
    <parameters/>
    <provisioning>12349</provisioning>
    <scheduledTime>2011-11-10T22:59:27.845Z</scheduledTime>
    <server>ip-10-194-237-171.ec2.internal</server>
    <startTime>2011-11-10T23:00:10.905Z</startTime>
    </item>
    </Execution>

application/jason

    {"item": {
    "@id": "1fb013d7-7cd2-479e-bf59-3e1216eec920",
    "owner": {
    "@id": "171",
    "$": "testuser"
    },
    "currentTime": "2011-11-11T10:15:51.919Z",
    "finishTime": "2011-11-10T23:00:10.905Z",
    "logFile": "provisioning/12349/log/1fb013d7-7cd2-479e-bf59-3e1216eec920",
    "parameters": null,
    "provisioning": "12349",
    "scheduledTime": "2011-11-10T22:59:27.845Z",
    "server": "ip-10-194-237-171.ec2.internal",
    "startTime": "2011-11-10T23:00:10.905Z"
    }}

text/xml

    <Execution>
    <item id="1fb013d7-7cd2-479e-bf59-3e1216eec920">
    <owner id="171">testuser</owner>
    <currentTime>2011-11-11T10:13:19.987Z</currentTime>
    <finishTime>2011-11-10T23:00:10.905Z</finishTime>
    <logFile>
    provisioning/12349/log/1fb013d7-7cd2-479e-bf59-3e1216eec920
    </logFile>
    <parameters/>
    <provisioning>12349</provisioning>
    <scheduledTime>2011-11-10T22:59:27.845Z</scheduledTime>
    <server>ip-10-194-237-171.ec2.internal</server>
    <startTime>2011-11-10T23:00:10.905Z</startTime>
    </item>
    </Execution>

 

findExecution

Return an execution by id.

Parameters

Name Type Description
id
String
id of the execution to return
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/execution/89d594c5-132c-4e53-8064-d592c31592dd?s=3758d0d1-9036-482c-9404-934fa604925e

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/postget/execution/89d594c5-132c-4e53-8064-d592c31592dd?s=3758d0d1-9036-482c-9404-934fa604925e HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 10:17:09 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 589
    Connection: keep-alive

application/xml

    <Execution id="89d594c5-132c-4e53-8064-d592c31592dd" xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <owner id="171">testuser</owner>
    <currentTime>2011-11-11T10:17:09.085Z</currentTime>
    <finishTime>2011-10-20T12:39:56.589Z</finishTime>
    <logFile>provisioning/12349/log/89d594c5-132c-4e53-8064-d592c31592dd</logFile>
    <parameters/>
    <provisioning>12349</provisioning>
    <scheduledTime>2011-10-20T12:33:39.433Z</scheduledTime>
    <server>ip-10-84-67-142.ec2.internal</server>
    <startTime>2011-10-20T12:36:21.042Z</startTime>
    </Execution>

application/jason

    {
    "@id": "89d594c5-132c-4e53-8064-d592c31592dd",
    "owner": {
    "@id": "171",
    "$": "testuser"
    },
    "currentTime": "2011-11-11T10:19:54.575Z",
    "finishTime": "2011-10-20T12:39:56.589Z",
    "logFile": "provisioning/12349/log/89d594c5-132c-4e53-8064-d592c31592dd",
    "parameters": null,
    "provisioning": "12349",
    "scheduledTime": "2011-10-20T12:33:39.433Z",
    "server": "ip-10-84-67-142.ec2.internal",
    "startTime": "2011-10-20T12:36:21.042Z"
    }

text/xml

    <Execution id="89d594c5-132c-4e53-8064-d592c31592dd">
    <owner id="171">testuser</owner>
    <currentTime>2011-11-11T10:17:09.373Z</currentTime>
    <finishTime>2011-10-20T12:39:56.589Z</finishTime>
    <logFile>
    provisioning/12349/log/89d594c5-132c-4e53-8064-d592c31592dd
    </logFile>
    <parameters/>
    <provisioning>12349</provisioning>
    <scheduledTime>2011-10-20T12:33:39.433Z</scheduledTime>
    <server>ip-10-84-67-142.ec2.internal</server>
    <startTime>2011-10-20T12:36:21.042Z</startTime>
    </Execution>

 

createExecution

Create an execution object in preparation for job execution.

Parameters

Name Type Description
provisioningid
Long
the unique id of the provisioning
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
POST

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/execution/create?s=3758d0d1-9036-482c-9404-934fa604925e&provisioningid=12349

    POST https://datacloud2.pervasive.com/EntityAPIService/REST/postget/execution/create?s=3758d0d1-9036-482c-9404-934fa604925e&provisioningid=12349 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 0

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 10:23:17 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 370
    Connection: keep-alive

 

editExecution

Edit an execution object that has not yet been started.

Parameters

Name Type Description
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
POST

Example

Request

Header

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/execution?s=e1f536c7-baca-4268-a668-68ceba857a57

    POST
    https://datacloud2.pervasive.com/EntityAPIService/REST/postget/execution?s=e1f536c7-baca-4268-a668-68ceba857a57 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 137

Body

    <Execution id="2cc5a73f-fd58-4850-b4cc-4a5d6d67cfc2">
    <parameters>
    <parameter key='mykey1'>myvalue</parameter>
    </parameters>
    </Execution>

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 13:21:06 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

putExecutionFile

Upload a file associated with an Execution.

Parameters

Name Type Description
executionid
String
id of the Execution
filename
String
name of the file to upload
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
POST

Example

Request
Header

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/execution/2cc5a73f-fd58-4850-b4cc-4a5d6d67cfc2/file?s=3758d0d1-9036-482c-9404-934fa604925e&filename=pute.txt

    POST
    https://datacloud2.pervasive.com/EntityAPIService/REST/postget/execution/2cc5a73f-fd58-4850-b4cc-4a5d6d67cfc2/file?s=3758d0d1-9036-482c-9404-934fa604925e&filename=pute.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/octet-stream
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 381

application/octet-stream

    <Execution xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <item id="2cc5a73f-fd58-4850-b4cc-4a5d6d67cfc2">
    <owner id="171">testuser</owner>
    <currentTime>2011-11-11T10:28:09.264Z</currentTime>
    <parameters/>
    <provisioning>12349</provisioning>
    <scheduledTime>2011-11-11T10:23:17.195Z</scheduledTime>
    </item>
    </Execution>

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 10:28:30 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

getExecutionFile

Download a file associated with an Execution.

Parameters

Name Type Description
executionid
String
id of the Execution
filename
String
name of the file to Download
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/execution/2cc5a73f-fd58-4850-b4cc-4a5d6d67cfc2/file?s=3758d0d1-9036-482c-9404-934fa604925e&filename=pute.txt

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/postget/execution/2cc5a73f-fd58-4850-b4cc-4a5d6d67cfc2/file?s=3758d0d1-9036-482c-9404-934fa604925e&filename=pute.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/octet-stream
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    content-disposition: attachment; filename=pute.txt
    Content-Type: application/octet-stream
    Date: Fri, 11 Nov 2011 10:31:12 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

application/octet-stream

    This is the content of a sample file named pute.txt
    Second line of the sample file content.
    End of the Sample content

 

runExecution

This call creates an execution and starts the execution in a single call.

Parameters

Name Type Description
provisioningid
Long
id of the Provisioning
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
POST

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/run?s=3758d0d1-9036-482c-9404-934fa604925e&provisioningid=12349

    POST https://datacloud2.pervasive.com/EntityAPIService/REST/postget/run?s=3758d0d1-9036-482c-9404-934fa604925e&provisioningid=12349 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: */*
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 0

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 10:35:05 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 370
    Connection: keep-alive

 

listCredentials

List the credentials associated with the current user

Parameters

Name Type Description
start
Integer
0-indexed ordinal of the first record to return
max
Integer
the maximum number of records to return
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/credential?max=1&start=0&s=3758d0d1-9036-482c-9404-934fa604925e

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/postget/credential?max=1&start=0&s=3758d0d1-9036-482c-9404-934fa604925e HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 07:26:34 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 348
    Connection: keep-alive

application/xml

    <Credential xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <item id="2972028">
    <owner id="171">testuser</owner>
    <expiration>2011-04-23T05:01:25.500Z</expiration>
    <parameters>
    <parameter key="myKey">myValue</parameter>
    </parameters>
    <type>executionSession</type>
    </item>
    </Credential>

application/jason

    {"item": {
    "@id": "2972028",
    "owner": {
    "@id": "171",
    "$": "testuser"
    },
    "expiration": "2011-04-23T05:01:25.500Z",
    "parameters": {"parameter": {
    "@key": "myKey",
    "$": "myValue"
    }},
    "type": "executionSession"
    }}

text/xml

    <Credential>
    <item id="2972028">
    <owner id="171">testuser</owner>
    <expiration>2011-04-23T05:01:25.500Z</expiration>
    <parameters>
    <parameter key="myKey">myValue</parameter>
    </parameters>
    <type>executionSession</type>
    </item>
    </Credential>

 

findCredential

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

Parameters

Name Type Description
id
Long
id of the credential to return
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/credential/3140582?s=3758d0d1-9036-482c-9404-934fa604925e

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/postget/credential/3140582?s=3758d0d1-9036-482c-9404-934fa604925e HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 07:31:19 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 318
    Connection: keep-alive

application/xml

    <Credential id="3140582" xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <owner id="171">testuser</owner>
    <expiration>2031-09-23T20:53:08.608Z</expiration>
    <parameters>
    <parameter key="sessionId"/>
    </parameters>
    <type>OAUTH_SESSION</type>
    </Credential>

application/jason

    { "@id": "3140582",
    "owner": {
    "@id": "171",
    "$": "testuser"
    },
    "expiration": "2031-09-23T20:53:08.608Z",
    "parameters": {"parameter": {"@key": "sessionId"}},
    "type": "OAUTH_SESSION"
    }

text/xml

    <Credential id="3140582">
    <owner id="171">testuser</owner>
    <expiration>2031-09-23T20:53:08.608Z</expiration>
    <parameters>
    <parameter key="sessionId"/>
    </parameters>
    <type>OAUTH_SESSION</type>
    </Credential>

 

editCredential

Edit a credential associated with the user

Parameters

Name Type Description
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
POST

Example

Request

Header

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/credential?s=e1f536c7-baca-4268-a668-68ceba857a57

    POST
    https://datacloud2.pervasive.com/EntityAPIService/REST/postget/credential?s=e1f536c7-baca-4268-a668-68ceba857a57 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 197

Body

    <Credential id="2972045">
    <expiration>2011-04-23T01:01:25.500-04:00</expiration>
    <parameters>
    <parameter key="myKey">myValue</parameter>
    </parameters>
    <type>executionSession</type>
    </Credential>

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 20:28:34 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

putCredentialFile

Upload a file associated with a Credential.

Parameters

Name Type Description
credentialid
Long
the id of the credential
filename
String
filename of the file
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
POST

Example

Request
Header

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/credential/2972045/file?s=3758d0d1-9036-482c-9404-934fa604925e&filename=putd.txt

    POST https://datacloud2.pervasive.com/EntityAPIService/REST/postget/credential/2972045/file?s=3758d0d1-9036-482c-9404-934fa604925e&filename=putd.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/octet-stream
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 293

application/octet-stream

    This is the content of a sample file named putd.txt
    Second line of the sample file content.
    End of the Sample content

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 07:40:06 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

getCredentialFile

Download a file associated with a Credential.

Parameters

Name Type Description
credentialid
Long
the id of the credential
filename
String
filename to download
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/credential/2972045/file?s=3758d0d1-9036-482c-9404-934fa604925e&filename=putc.txt

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/postget/credential/2972045/file?s=3758d0d1-9036-482c-9404-934fa604925e&filename=putc.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/octet-stream
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    content-disposition: attachment; filename=putc.txt
    Content-Type: application/octet-stream
    Date: Fri, 11 Nov 2011 07:43:32 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0

application/octet-stream

    This is the content of a sample file named putc.txt
    Second line of the sample file content.
    End of the Sample content

 

listUsers

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

Parameters

Name Type Description
start
Integer
0-indexed ordinal of the first record to return
max
Integer
the maximum number of records to return
sessionId
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/user?max=1&start=0&s=3758d0d1-9036-482c-9404-934fa604925e

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/postget/user?max=1&start=0&s=3758d0d1-9036-482c-9404-934fa604925e HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 08:11:39 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 461
    Connection: keep-alive

application/xml

    <User xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <item id="171">
    <account>2708</account>
    <active>true</active>
    <administrator>false</administrator>
    <deleted>false</deleted>
    <lastmodifieddate>-1909755168</lastmodifieddate>
    <name>testuser</name>
    <parameters>
    <parameter secure="true" key="key"/>
    </parameters>
    <superUser>false</superUser>
    <temporarypassword>false</temporarypassword>
    </item>
    </User>

application/jason

    {"item": {
    "@id": "171",
    "account": "2708",
    "active": "true",
    "administrator": "false",
    "deleted": "false",
    "lastmodifieddate": "-1909755168",
    "name": "testuser",
    "parameters": {"parameter": {
    "@secure": "true",
    "@key": "key"
    }},
    "superUser": "false",
    "temporarypassword": "false"
    }}

text/xml

    <User>
    <item id="171">
    <account>2708</account>
    <active>true</active>
    <administrator>false</administrator>
    <deleted>false</deleted>
    <lastmodifieddate>-1909755168</lastmodifieddate>
    <name>testuser</name>
    -<parameters>
    <parameter secure="true" key="key"/>
    </parameters>
    <superUser>false</superUser>
    <temporarypassword>false</temporarypassword>
    </item>
    </User>

 

findUser

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

Parameters

Name Type Description
id
Long
id of the user to return
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/user/171?s=3758d0d1-9036-482c-9404-934fa604925e

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/postget/user/171?s=3758d0d1-9036-482c-9404-934fa604925e HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 08:16:59 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 448
    Connection: keep-alive

application/xml

    <User id="171" xmlns:ns2="http://datasolutions.pervasive.com/api/entity">
    <account>2708</account>
    <active>true</active>
    <administrator>false</administrator>
    <deleted>false</deleted>
    <lastmodifieddate>-1909755168</lastmodifieddate>
    <name>testuser</name>
    <parameters>
    <parameter secure="true" key="key"/>
    </parameters>
    <superUser>false</superUser>
    <temporarypassword>false</temporarypassword>
    </User>

application/jason

    {
    "@id": "171",
    "account": "2708",
    "active": "true",
    "administrator": "false",
    "deleted": "false",
    "lastmodifieddate": "-1909755168",
    "name": "testuser",
    "parameters": {"parameter": {
    "@secure": "true",
    "@key": "key"
    }},
    "superUser": "false",
    "temporarypassword": "false"
    }

text/xml

    <User id="171">
    <account>2708</account>
    <active>true</active>
    <administrator>false</administrator>
    <deleted>false</deleted>
    <lastmodifieddate>-1909755168</lastmodifieddate>
    <name>testuser</name>
    <parameters>
    <parameter secure="true" key="key"/>
    </parameters>
    <superUser>false</superUser>
    <temporarypassword>false</temporarypassword>
    </User>

 

editUser

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

Parameters

Name Type Description
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
POST

Example

Request

Header

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/user?s=e1f536c7-baca-4268-a668-68ceba857a57

    POST https://datacloud2.pervasive.com/EntityAPIService/REST/postget/user?s=e1f536c7-baca-4268-a668-68ceba857a57 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 604

Body

    <User id="171">
    <name>testuser</name>
    <parameters>
    <parameter key="membership.company">Testing</parameter>
    <parameter key="membership.firstname">Test</parameter>
    <parameter key="awsSecretKey">9jY7cT605V4R3vdWJb3Ra+XbVXLwi7fYzum4fxKa</parameter>
    <parameter key="membership.email">testing@testing.com</parameter>
    <parameter key="membership.lastname">User</parameter>
    <parameter key="userkey">uservalue</parameter>
    <parameter key="membership.phone">123-456-789</parameter>
    <parameter key="awsAccessKey">AKIAIGM4XXTMW3BYABPA</parameter>
    <parameter key="mykey">myValue</parameter>
    </parameters>
    </User>

Response

Head

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 13:16:43 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

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
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
POST

Example

Request

Header

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/user/171/file?s=3758d0d1-9036-482c-9404-934fa604925e&filename=putu.txt

    POST
    https://datacloud2.pervasive.com/EntityAPIService/REST/postget/user/171/file?s=3758d0d1-9036-482c-9404-934fa604925e&filename=putu.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    Content-Type: application/octet-stream
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com
    Content-Length: 485

application/octet-stream

    <Response id="171" xmlns="https://datacloud2.pervasive.com/EntityAPIService/REST/postget/user/171">
    <account>2708</account>
    <active>true</active>
    <administrator>false</administrator>
    <deleted>false</deleted>
    <lastmodifieddate>-1909755168</lastmodifieddate>
    <name>testuser</name>
    <parameters>
    <parameter key="key" secure="true"/>
    </parameters>
    <superUser>false</superUser>
    <temporarypassword>false</temporarypassword>
    </Response>

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 08:49:03 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

getUserFile

Download a file associated with a User.

Parameters

Name Type Description
userid
Long
id of the User
filename
String
filename to download
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/user/171/file?s=3758d0d1-9036-482c-9404-934fa604925e&filename=putu.txt

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/postget/user/171/file?s=3758d0d1-9036-482c-9404-934fa604925e&filename=putu.txt HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/octet-stream
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Thu, 10 Nov 2011 21:32:28 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

application/octet-stream

    This is the content of a sample file named putu.txt
    Second line of the sample file content.
    End of the Sample content

 

logout

Logout and terminate the API session

Parameters

Name Type Description
s
String
If the cookie is set with the "sessionId" , "s" is optional

Methods

Name
GET

Example

Request

    Url: https://datacloud2.pervasive.com/EntityAPIService/REST/postget/logout?s=e1f536c7-baca-4268-a668-68ceba857a57

    GET https://datacloud2.pervasive.com/EntityAPIService/REST/postget/logout?s=e1f536c7-baca-4268-a668-68ceba857a57 HTTP/1.1
    Accept-Encoding: gzip,deflate
    Accept: application/xml
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: datacloud2.pervasive.com

Response

Header

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Date: Fri, 11 Nov 2011 13:24:11 GMT
    Server: Sun GlassFish Enterprise Server v2.1.1
    X-Powered-By: Servlet/2.5
    Content-Length: 0
    Connection: keep-alive

 

Errors

Following are the typical errors encountered during the RESTful calls