1.3 Navigating the API Documentation

The PlateSpin Transformation Manager REST API interactive console uses the open source Swagger UI tool to provide documentation about its APIs. You can learn about the APIs and interact with the REST service to try them.

1.3.1 Viewing API Categories

The REST APIs are grouped according to product components in the following categories:

  • applications

  • batches

  • cloudlocations

  • clusterhosts

  • clusters

  • connectors

  • credentials

  • dependencies

  • environments

  • migrationservers

  • networks

  • operatingsystems

  • organizations

  • platforms

  • preimages

  • processes

  • projects

  • repositories

  • resourcegroups

  • resourcelimits

  • subnets

  • system

  • transformations

  • types

  • waves

1.3.2 Viewing Operations

In the interactive API console, select one of the following options to expand a category and view the operations available:

  • Show/Hide: Expands the API category to show a list of member operations, or collapses the API category.

  • List Operations: Expands the API category to show a list of member operations.

  • Expand Operations: Expands the API category and each of the member operations.

The list view shows the operation type (Get, Post, Put, Delete), the command, and a brief definition for each operation.

Expand an operation to view the following information about the operation:

  • Query method (GET, POST, PUT)

  • Model schema

  • Query parameters (as appropriate)

  • Request definition and limitations

  • Response format

  • Response language support (JSON)

Most operations will have parameters that refine the query. An expanded operation view includes a list of parameters, the default values for them, and a brief description of the parameter. The following example shows the parameters for a /project query.

1.3.3 Trying Queries

You can try an API to generate the proper command. Specify values for any required parameters, then click Try it out.

The following example shows the /types operation that does not have parameters.

Click Try it out! to generate the corresponding query as a Curl command and an HTTP request URL It also includes the command response body, code, and headers.