Swagger template - common HTML codes

Overview

Note:
In addition to the pertinent help topics enclosed in this section, users can access the API documentation available here through Swagger. The Swagger UI provides annotations around the following:
  • Method annotation
  • API definition
  • Descriptions

For more information on using Swagger UI, click here.

This topic walks through the template that is used within Swagger and within this technical guide. As you review each method, you will notice the following specifications:

  • Method
  • Parameters
  • Sample request
  • Sample response and HTML codes

Method

The Method table below specifies one of the following operations:
  • POST: creates a REST API resource
  • PUT: updates a REST API resource
  • PATCH: modifieds an existing REST API resource
  • GET: retrieves information about the REST API resource
  • DELETE: deletes a REST API resource or related component

Parameters

A parameter is an element that is included in the request to return a specific value or sets of values. The parameters documented for the REST methods are path parameters consisting of a URL snippet.

Sample Request

A sample request is included for each method.

Sample Response and Response Message

A sample response is included for each method as well a response message and available HTML codes.

Table 1. Response message and HTML codes
Code Description
200 Successful response
400 Bad request
401 Not Authorized
403 Forbidden
500 Server error