REST APIs in HCL OneTest Data

HCL® OneTest Data uses schemas to generate the test data. You can create and design a schema from the Data Fabrication page into your project. If you want to perform the operations on schema from any external applications, then HCL® OneTest Data provides you a list of REpresentational State Transfer (REST) Application Programming Interface (API).

To perform any operations on schema in HCL® OneTest Data, you must understand the following terminologies:
  • Dictionary: The dictionary is a collection of all entities you need to define in a schema.

  • Schema: The schema is a collection of definitions of the entities required to generate the test data.

    The entities of a schema are classified into the following types:

    • Category: A category is used to organize other entities in a schema in a structural format.
    • Group: A group is a complex data entity that consists of other entities.
    • Item: An item is a simple data entity that does not consist of other entities.
  • Structure: The structure is a view that defines how the entities of a schema are organized and related to each other.

Prerequisites

The following prerequisites must be met to perform the operations on schema from any external applications:

  • You must have access to HCL OneTest Server.
  • You must have created a project in HCL OneTest Server.
  • You must have a bearer token for authentication. See Retrieval of a bearer token.
  • You must have the project identification details where you want to perform the operations on schema. See Retrieval of the project details.

Types of the operations on schema

You can perform the following operations on a schema:

Operations Description
Retrieval of a refresh token

Use this operation to retrieve the details of the refresh token.

Retrieve a bearer token

Use this operation to retrieve the details of the bearer token.

Retrieve details of a project

Use this operation to retrieve the details of your project such as project id and project name.

Retrieve details of a schema

Use this operation to retrieve the details of a schema.

Retrieve the schema identification number

Use this operation to retrieve the identification number of a schema.

Retrieve details of all schemas

Use this operation to retrieve the details of all the schemas in the selected project.

Retrieve details of a type

Use this operation to retrieve the details of a particular type of a schema.

Retrieve details of all types

Use this operation to retrieve the details of all the types of a schema.

Create a schema

Use this operation to create a new schema in the selected project.

Import a schema

Use this operation to import a schema in the selected project.

Modify a schema

Use this operation to design and modify a schema in the selected project.

Download a schema

Use this operation to download a schema on your computer.

Delete a schema

Use this operation to delete any existing schema from your project.