Top
Systemwalker Runbook Automation Reference Guide
Systemwalker

5.1.4 API Description Format

This section describes the general format used to explain each API in this document.

Description

This section describes the function of the API.

Request URI

/rbaserver/[URI for each API]

Request Parameters

This section lists the request parameters in table format.

Parameter name

Required?

Item

Item description

Request parameter name

Yes: Represents a required item

Description

Description of each parameter

Type

Parameter type

Value

Parameter value

Request Body

This section describes the body of each request.

Sample Request

This section describes a sample request.

Response

This section describes the response for each API.

<Status code>

This section describes the status codes.

<XML>

This section describes the response in XML format.

<Element>

This section describes each XML element in table format.

Sample Response

This section describes a sample response.