User Guide > User Guide > DataCloud API User Guide > CloudRest API > Product Resource
Was this helpful?
Product Resource
The product resource gives you access to view and manipulate the product entity using the CloudRest API.
The following actions are available through the product resource:
List Products
Lists the products associated with the current user, including products not controlled by the user, but for which the user owns provisionings.
Use the GET method for this action.
URL
https://datacloud2.pervasive.com/EntityAPIService/REST/product?start={start}&max={max}&s={sessionId}
The following response types are available via the optional Accept header in your request:
• application/xml (default)
• application/json
• text/xml
Parameters
 
Name
Type
Description
Required?
start
Integer
0-indexed ordinal of the first record to return.
No.
max
Integer
Maximum number of records to return.
No.
s
String
ID of the active session.
Optional if the sessionId cookie has been set.
Example
Request
GET https://datacloud2.pervasive.com/EntityAPIService/REST/product?max=10&start=0&s=49bfe32d-df30-4797-a8b1-96da5c1b5609 HTTP/1.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>390</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": "390",
       "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": "390",
       "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>390</destination>
        <group>1244</group>
        <lastmodifieddate>-1909684168</lastmodifieddate>
        <name>Sub Test</name>
        <parameters/>
        <parentProvisioningId>15046</parentProvisioningId>
        <process/>
        <userProduct>true</userProduct>
    </item>
   .
   .
   .
</Product>
Find Product
Returns the product associated with the supplied ID.
Use the GET method for this action.
URL
https://datacloud2.pervasive.com/EntityAPIService/REST/product/{productId}?s={sessionId}
The following response types are available via the optional Accept header in your request:
• application/xml (default)
• application/json
• text/xml
Parameters
 
Name
Type
Description
Required?
productId
String
ID of the product to return.
Yes.
s
String
ID of the active session.
Optional if the sessionId cookie has been set.
Example
Request
GET https://datacloud2.pervasive.com/EntityAPIService/REST/product/00c55ba1-2fcb-4109-aa73-8ff2aa8d4af9?s=49bfe32d-df30-4797-a8b1-96da5c1b5609
HTTP/1.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>390</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": "390",
    "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>390</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>
Edit Product
Allows you to edit a product that is associated with the current user.
Use the POST method for this action. Supply the complete product object in the body of your request.
URL
https://datacloud2.pervasive.com/EntityAPIService/REST/product?s={sessionId}
Parameters
 
Name
Type
Description
Required?
s
String
ID of the active session.
Optional if the sessionId cookie has been set.
Example
Request
Header
POST https://datacloud2.pervasive.com/EntityAPIService/REST/product?s=49bfe32d-df30-4797-a8b1-96da5c1b5609 HTTP/1.1
Content-Type: application/xml
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>390</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
Create Product
Allows you to create a product that is associated with the current user.
Use the POST method for this action. Supply the complete product object in the body of your request.
URL
https://datacloud2.pervasive.com/EntityAPIService/REST/product/create?s={sessionId}
Parameters
 
Name
Type
Description
Required?
s
String
ID of the active session.
Optional if the sessionId cookie has been set.
Example
Request
Header
POST https://datacloud2.pervasive.com/EntityAPIService/REST/product/create?s=49bfe32d-df30-4797-a8b1-96da5c1b5609 HTTP/1.1
Content-Type: application/xml
Host: datacloud2.pervasive.com
Content-Length: 739
Body
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Product xmlns:ns2="http://datasolutions.pervasive.com/api/entity" permissions="READ WRITE EXECUTE GRANT" >
    <createdBy id="171">testuser</createdBy>
    <createdDate>2014-03-26T10:42:32.654-05:00</createdDate>
    <lastModifiedBy id="171">testuser</lastModifiedBy>
    <lastModifiedDate>2014-04-03T17:09:04.145-05:00</lastModifiedDate>
    <owner id="171">testuser</owner>
    <active>true</active>
    <concurrent>false</concurrent>
    <deleted>false</deleted>
    <description></description>
    <destination>378</destination>
    <destinationType>V9_LINUX</destinationType>
    <engine>V9</engine>
    <lockedDestination>false</lockedDestination>
    <name>TestProduct</name>
    <parameters>
<parameter key="mykey2"/>
        <parameter key="ProviderID"/>
        <parameter key="ProviderConfig"/>
    </parameters>
    <parentProvisioningId>50583</parentProvisioningId>
    <process/>
    <remote>false</remote>
    <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
Last modified date: 12/17/2021