Develop > Application Programming Interface > Legacy APIs > Availablevalues API

Availablevalues API

Use this API to retrieve the list of available values for a dynamic property.

Base URL

https://<host>:<port>/csa/rest

Details

URI /availablevalues/<property_id>
property_id is an option model property, and is part of service design, offering and subscription artifacts.
Method POST
Parameters

userIdentifier=<user_id>
    Required; the user ID you want to use as credentials for this API call. See Get userIdentifier for the steps required to get the userIdentifier value.

Request Body Ampersand (&) separated name=value pairs, where the value on the left side of the equal sign (=) represents the parameter name configured for a dynamic property, and the value on the right side is the value the user selected from the parent property.  For example, a request body might contain: first=parent1value&countparam=mycount.
Returns 200 - Ok
400 - Not authorized
404 - Not found
500 - Server exception

Example use context

From the subscriber portal, select a property from the drop down list. The value for any associated dynamic property is populated spontaneously.

Example

The following URL is sent:

https://<host>:<port>/csa/rest/availablevalues/90e763a43ddc18e5013ddc2f134c0088 ?userIdentifier=90d96588360da0c701360da0f1d5f483

The following is sent in the request body:

first=parent1Value

The following response is returned:

<Property>
  <id>90e763a43ddc18e5013ddc2f134c0088</id>
  <name>child1</name>
  <displayName>child1</displayName>
  <dynamicValueEnabled>true</dynamicValueEnabled>
  <dynamicScriptName>sample_jsp.jsp</dynamicScriptName>
  <dynamicScriptParameters>
    first=[CLIENT:parent1]
  </dynamicScriptParameters>
  <availableValues>
    <value>value1</value>
    <displayName>value1 displayName</displayName>
    <description>value1 description</description>
  </availableValues>
  ...
</Property>

Send Help Center feedback