Request tab

Use the Request tab to specify the API operation, Method and URL, and Request parameters.

This table shows the properties of the API operation:

Name Description
Method Select an operation: GET, POST, PUT or DELETE.
Endpoint Name Specify the API endpoint name, group of APIs in one API suite. In the first release this must be unique.
Endpoint Path Specify part of URL path identifying the API endpoint. In the first release this must be unique.
Resource Name Specify the API name.
Resource Path You must specify the end of an URL path identifying the resource with the definition of all path parameters. Path parameters must be defined in curly brackets {}, for example: /resourcepath/{PathParameterName}/

Click + to add a new request parameter.

This table shows properties of request parameters:

Name Description

Name

Specify the request parameter name. The names must be unique.

Description

Optionally, specify the request parameter description.

Parameter Type

Select the request parameter type: query, path or header.

Path parameters are used to construct the URL path and cannot be blank.

Data type Select the request parameter data type: string, number, integer, or boolean.

Required

Select, if the request parameter is required.