Creating a REST API web service request definition - Documentation for BMC Helix Platform 20.08

FieldDescriptionExampleNameType a name for the web request.Create IssueRequest MethodSelect the HTTP method of the web request.POST

(Optional) Multipart Request

If you want a request to be of the multipart type, then select this toggle key.

Important: The Multipart Request toggle key is displayed only when you select Post and Put in the Request Method field.

None

(Optional) Add Part Names

Click this option to enter the key as given in the REST API.

Important: The Add Part Names field is displayed only when you select the Multipart Request toggle key.

Attach1

PathSpecify the URL path on which the method is invoked.
Format of the URL: /rest/api//rest/api/latest/issue/{issueid}(Optional) BodyFrom the list, select the Document Definition that you created earlier from which you want to copy the body in JSON format. Typically, this is needed for the POST or PUT methods, but might not be required for other methods.
Important: The Body field is not displayed if you have selected Post or Put as Request Method and the Multipart Request toggle key. This happens because in a multipart request, you cannot post a JSON, but you can post other content types, for example, .zip and .jpeg.None(Optional) Response

From the list, select the Document Definition that you created earlier from which you want to copy the response in JSON format.

Important: If the content type of the Response field is other than JSON, the response is returned as an attachment. While designing a process, you can map the Response field with the attachment.

None

Error on Unsuccessful Response

Clear the check box so that if an error occurs when the web API is run, the process associated with the web API is still run.

Important: Only when you clear this check box, you can view the web API response metadata fields in a process and use the metadata fields to build process conditions.

None(Optional) Add HeadersAdd the headers for this web request.None(Optional) Query ParametersAdd the query parameters for this web request.NoneEncode Request ParametersSelect the toggle button to encode the following parameters:

Important:

Yes