You are here: Reference Manual > FME Server Web Services > Utility Services > REST Service > Optional Parameters

Optional Parameters

The following optional parameters can be specified in REST API method calls:

Parameter	Description
detail	Query-string parameter that applies to all API calls. It accepts one of two values: high or low. High detail renders more comprehensive API responses. Low detail renders minimal API responses. The purpose of this feature is to potentially improve performance by controlling response size and computational complexity.
f	Format matrix parameter that can be set if it is not possible to set the HTTP "Accept" request header. Accepted values are xml, json, contents, or text. Use xml or json to render a response in either XML or JSON. text and contents are reserved for specific API calls that support plain text download, such as transformation log files, or files download, such as the shared resource API or workspace and resource downloading.

Parameter

Description

detail

Query-string parameter that applies to all API calls. It accepts one of two values: high or low. High detail renders more comprehensive API responses. Low detail renders minimal API responses. The purpose of this feature is to potentially improve performance by controlling response size and computational complexity.

Format matrix parameter that can be set if it is not possible to set the HTTP "Accept" request header. Accepted values are xml, json, contents, or text. Use xml or json to render a response in either XML or JSON. text and contents are reserved for specific API calls that support plain text download, such as transformation log files, or files download, such as the shared resource API or workspace and resource downloading.