Mobile Platform as a Service:Parameter settings

The parameter settings apply to API services of the HTTP type. You do not need to configure parameters for APIs that are created in automatic import mode.

• Request Parameters: Specify dynamic parameters and URL query parameters in Path. The parameter names must be unique.

  • Parameter Name: Required. The name of the parameter.

    Note

    If you set this parameter to Path, make sure that the name is the same as that in the request path. For example, if the Request Path parameter is set to /pets/${id}, the parameter name must be id.

  • Parameter Location: Required. The parameter is in the path or query string.

  • Type: Required. You can select String, Int, Long, Float, Double, or Boolean.

  • Default Value: Optional. The default value of the parameter.

  • Description: Optional. The description of the parameter.

• Request Body: The data model and Content-Type of the request body.

  Note

  The request body configuration is displayed only when the API is called in the POST mode.

  • Request Body Type: The following types of request bodies are supported: String, Int, Long, Float, Double, Boolean, List, Map, and Object.

  • Message Type: Supported message types include application/json, application/x-www-form-urlencoded, and application/protobuf.

• Response Result: Specifies the type of response result.

  • Response Result Type: Indicates a basic data type or a customized data model.