Develop > Application Programming Interface > Legacy APIs > Values for the restrict parameter

Values for the restrict Parameter

The rest.restrict property in the csa.properties file (<CSA>/jboss-as/standalone/deployments/csa.war/WEB-INF/classes) indicates if the fields specified in the rest.restrict.fields property should be included in the output of the REST response.

The rest.restrict.fields property in the csa.properties file includes a comma separated list of the fields that are not included in the REST response. By default the rest.restrict.fields property includes these fields: createdBy, updatedBy, createdOn, updatedOn, description, iconUrl, and categoryType.

The exclusion of primitive types such as booleans (isCriticalSystemObject or disabled) is not supported.

The createdBy, updatedBy, createdOn and updatedOn fields are always displayed for service instance, service request, and service subscription regardless of the configuration.

The restrict parameter has the following values:

  • True: Fields included in the rest.restrict.fields property are not included in the REST response. This is the default.
  • False: Fields included in the rest.restrict.fields property are included in the REST response.

You can overwrite the default value (restrict=true) by adding the restrict parameter to the REST request URL. For example:

https://<host>:<port>/csa/rest/artifact/4028caf84bd9cc4a014bd9d802b801c2?userIdentifier=90d96588360da0c701360da0f1d600a1&restrict=false