Reviewing One or More Configuration Parameters Using the Configuration Parameter Review API

This procedure describes how to view information about configuration parameters.

Context

Procedure

Determine how many parameters you wish to view. If you want to view a single parameter, or all of them, do one of the following:
- To view a single parameter and its information, use the GET /parameters/{parameterName} endpoint.
```
GET {{runtime_URL}}/parameters/{parameterName}?realm={realm_name}&includeMetadata={true|false}&consolidate={true|false}
                  
```
- To view all parameters and their information, use the GET /parameters endpoint.
```
GET {{runtime_URL}}/parameters?realm={realm_name}&includeMetadata={true|false}&consolidate={true|false}
                  
```
Note

In the sample URLs in this topic, replace {{runtime_url}} with the desired runtime URL from the Environment Details table on the SAP Ariba Developer Portal discovery page for this API.

consolidate

Set to true to include both default and customer defined parameters; set to false to include only customer defined parameters. Default is false.

includeMetadata

Set to true to include metadata fields. See Results section below for the list of fields returned by default and when this is true. Default is false.

parameterName

The exact name of the desired parameter. You can get a list of supported parameter names by retrieving all parameters and their information, as described above.
To view a subset of parameters, use the GET /parameters endpoint and specify the $filter parameter or the $search parameter.
- $filter
  Limits the response to parameters that match the specified filters.
```
GET {{runtime_URL}}/parameters?realm={realm_name}&includeMetadata={true|false}&consolidate={true|false}$filter={filter_list}
                           
```
- $search
  Limits the response to parameters whose parameterName or description fields contain the specified string.
```
GET {{runtime_URL}}/parameters?realm={realm_name}&includeMetadata={true|false}&consolidate={true|false}$search={search_string}
```
The filter list for the $filter parameter can query the following fields using the eq operator. Specify the exact target value in the filter expression:

description

String. The parameter description. For example: $filter=description eq 'Specifies whether a receipt is required for expense items that are charged to a corporate credit card'

displayName

String. The parameter name displayed on the user interface. For example: $filter=displayName eq 'Charge Items Require Receipts'

isCustomerEditable

Boolean. True if the customer can edit the parameter; otherwise false. For example: $filter=isCustomerEditable eq true

isDefault

Boolean. True to retrieve only default parameters. False to retrieve both default parameters and customer defined parameters. For Example: $filter=isDefault eq true

parameterName

String. The internal name of the parameter. For example: $filter=parameterName eq 'Application.Expense.ChargeItemsRequireReceipts'

parameterType

String. The data type of the parameter. For example: $filter=parameterType eq 'java.lang.String'

Results

By default, the response includes the following fields:

displayName
isDefault
parameterName
parameterValue

If you have set includeMetadata=true, the following additional fields are included:

dataType
defaultValue
isCustomerEditable
description