User Guide > User Guide > DataCloud API User Guide > CloudRest API > Provisioning Resource
Was this helpful?
Provisioning Resource
The provisioning resource gives you access to view and manipulate the provisioning entity using the CloudRest API.
The following actions are available through the provisioning resource.
List Provisionings
List the provisionings associated with the current user.
Use the GET method for this action.
URL
https://datacloud2.pervasive.com/EntityAPIService/REST/provisioning?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
The 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/provisioning?max=5&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: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/sml
<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>
Find Provisioning
Return a provisioning by ID.
Use the GET method for this action.
URL
https://datacloud2.pervasive.com/EntityAPIService/REST/provisioning/{id}?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?
id
Long
ID of the provisioning 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/provisioning/12086?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 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>
Edit Provisioning
Edit a provisioning associated with the logged in user.
Use the POST method for this action. Supply the complete provisioning object in the body of your request.
URL
https://datacloud2.pervasive.com/EntityAPIService/REST/provisioning?s={sessionId}
Parameters
 
Name
Type
Description
Required?
s
String
ID of the active session.
Optional if the sessionId cookie has been set.
Example
Request
POST https://datacloud2.pervasive.com/EntityAPIService/REST/provisioning?s=49bfe32d-df30-4797-a8b1-96da5c1b5609 HTTP/1.1
Content-Type: application/xml
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
Create Provisioning
Create a new provisioning associated with the logged in user.
Use the POST method for this action. Supply the complete provisioning object in the body of your request.
URL
https://datacloud2.pervasive.com/EntityAPIService/REST/provisioning/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
POST https://datacloud2.pervasive.com/EntityAPIService/REST/provisioning/create?s=49bfe32d-df30-4797-a8b1-96da5c1b5609 HTTP/1.1
Content-Type: application/xml
Host: datacloud2.pervasive.com
Content-Length: 510
Body
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Provisioning xmlns:ns2="http://datasolutions.pervasive.com/api/entity" permissions="READ WRITE EXECUTE GRANT">
    <active>true</active>
    <engine>V9</engine>
    <expirationDate>2015-09-03T00:00:00-05:00</expirationDate>
    <name>container5</name>
    <overridable>false</overridable>
    <parameters>
        <parameter key="mykey2"/>
        <parameter key="ProviderID"/>
        <parameter key="ProviderConfig"/>
    </parameters>
    <process/>
    <product>IDSSSBV-E01W201-91900-01</product>
    <remote>false</remote>
    <startDate>2014-09-01T00:00:00-05:00</startDate>
    <user>171</user>
</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
Last modified date: 12/17/2021