User Guide > User Guide > DataCloud API User Guide > CloudRest API > Parameter Resource
Was this helpful?
Parameter Resource
The parameter resource gives you access to view and manipulate parameters using the CloudRest API.
Parameters can be attached to the following entities:
• Product
• Provisioning
The following actions are available through the parameter resource:
Find Parameter
Return the value of a parameter associated with an entity referenced by ID.
Use the GET method for this action. The parameter value is returned as plain text only.
URL
https://datacloud2.pervasive.com/EntityAPIService/REST/{entityType}/{id}/parameter?name={name}&s={sessionId}
Only the text/plain response type is available for this action.
Parameters
 
Name
Type
Description
Required?
entityType
String
Name of the entity (product or provisioning).
Yes.
id
Long
ID of the entity.
Yes.
name
String
The key of the parameter 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/parameter?name=mykey2&s=49bfe32d-df30-4797-a8b1-96da5c1b5609 HTTP/1.1
Accept: text/plain
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/plain
myValue2
Edit Parameter
Edit the value of a parameter associated with an entity referenced by ID. This action returns the previous value of the edited parameter.
Use the POST method for this action. Supply the parameter value in the body of your request.
URL
https://datacloud2.pervasive.com/EntityAPIService/REST/{entityType}/{id}/parameter?name={name}&s={sessionId}
Only the text/plain response type is available for this action.
Parameters
 
Name
Type
Description
Required?
entityType
String
Name of the entity type (product or provisioning).
Yes.
id
Long
ID of the entity.
Yes.
name
String
The key of the parameter to edit.
Yes.
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/12086/parameter?name=mykey2&s=49bfe32d-df30-4797-a8b1-96da5c1b5609
HTTP/1.1
Content-Type: text/plain
Host: datacloud2.pervasive.com
Content-Length: 8
Body
myvalue2
Response
Header
HTTP/1.1 200 OK
Content-Type: text/plain; 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
text/plain
my_old_value
Last modified date: 12/17/2021