Home
Test Author Guide
This guide describes how to create test assets in HCL OneTest™ Server and publish test assets to the Git repository that you have configured. This guide is intended for testers and test managers.
HCL OneTest Data overview
HCL OneTest™ Data is an automated and customizable tool to generate the test data. HCL OneTest Data is one of the components of HCL OneTest Server and can be accessed as Data Fabrication in the HCL OneTest Server GUI.
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).
Schema creation
When you want to generate test data by using HCL® OneTest™ Data, you must create a schema. You must use the POST method to create a schema from any external application.

Test Author Guide
This guide describes how to create test assets in HCL OneTest™ Server and publish test assets to the Git repository that you have configured. This guide is intended for testers and test managers.
- Datasets overview
  A dataset provides tests with variable data during a run. The test that uses a dataset at run time replaces a value in the recorded test with variable test data that is stored in the dataset.
- HCL OneTest Data overview
  HCL OneTest™ Data is an automated and customizable tool to generate the test data. HCL OneTest Data is one of the components of HCL OneTest Server and can be accessed as Data Fabrication in the HCL OneTest Server GUI.
  - Data design environment overview
    The data design environment is a graphical interface to design all its components and data generation rules to generate test data on user demand. To design the components for data generation, you must log in to HCL OneTest™ Server, and then create a project.
  - Task flows: HCL OneTest Data
    You can use the task flow diagram to get started with HCL OneTest™ Data. After you select your project in HCL OneTest Server and navigate to the Data Fabrication page, you can complete the tasks in sequence to generate the test data. You can click the links to get more information about the tasks.
  - Generation of test data
    To test an application, you use data that is passed to get real-time results. Since creating test data manually is time-consuming, you can use HCL OneTest™ Data, an automated tool to generate random test data. You can generate the test data in various file formats.
  - Status of generated test data
    You can view the status of all the test data generated jobs performed in your project, on the Jobs page.
  - Integration with other applications
    You can integrate certain applications with HCL OneTest™ Data to generate the test data.
  - 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).
    - Retrieval of a refresh token
      When you want to retrieve a bearer token to perform any operation on a schema, you must have a refresh token. You can retrieve the refresh token from any external application by using the POST method.
    - Retrieval of a bearer token
      When you want to perform any operation on a schema, you must have access to the project in which the schema exists. To gain access you require a bearer token. You can retrieve the bearer token from any external application by using the POST method.
    - Retrieval of the project details
      When you want to perform any operation on a schema, you must have the details of all the projects. You can retrieve the project details by using the GET method.
    - Retrieval of schema details
      When you want to perform any operation on a schema, you must know certain details about that schema. You can retrieve the details of a specific schema by using the GET method.
    - Retrieval of the details of all schemas
      When you want to modify any schema, you might want to know the basic information about all the schemas that are available in the HCL® OneTest™ Data project. You can retrieve information about all the schemas by using the GET method.
    - Retrieval of the type details
      When you want to modify a category, a group, or an item type in a schema, you require the type details, such as type id, type name, and type class. You can retrieve this information of any type by using the GET method.
    - Retrieval of the details of all types
      When you want to view the list of all the types and know their details, you can retrieve the details of all the types by using the GET method.
    - Schema creation
      When you want to generate test data by using HCL® OneTest™ Data, you must create a schema. You must use the POST method to create a schema from any external application.
    - Schema import
      When you want to use an existing schema to generate the test data, then by using the POST method you can import a schema into the HCL® OneTest™ Data project. The schema that you want to import must be either in the JSON or XSD format.
    - Schema modification
      After you create a schema, you must add a category, a group, or an item type to design the schema. You can then use the types of the schema to design the structural view of the schema. To perform all these modifications on the schema, you must use the PATCH method.
    - Schema deletion
      When you no longer want a schema in your project, you can delete the existing schema by using the DELETE method.
    - Schema download
      When you generate a schema, you might want to download the file on your computer. You must use the GET method to download the schema. The schema that you want to download must be either in the JSON or XSD format.
  - Troubleshooting
    You can troubleshoot some of the common problems that you might encounter when you use HCL OneTest™ Data.
  - References
    Find the understanding about the data design environment components of HCL® OneTest™ Data.

Schema creation

When you want to generate test data by using HCL® OneTest™ Data, you must create a schema. You must use the POST method to create a schema from any external application.

Prerequisites

You must have the following information before you create a schema:

A bearer token. See Retrieval of a bearer token.
Project details. See Retrieval of the project details.

REST API request

To create a schema, you must use the request with the following attributes:

Note: The schema you create is only the schema definition without any type definitions. The Dictionary and Structure are blank and they get updated only after you add the type definitions.

Request attributes	Request parameters
HTTP method	`POST`
Endpoint	https://{OneTest_Server}/onetest-data/rest/v1/otd/projects/{project_id}/schemas
Authorization	Yes
Request body	{ "name":<Schema_Name>, "description":<Schema_Description> }

Response code

You can view the following response after you run the request:

HTTP response code	Response example
200	{ "_id":"5efb2c6f0f11a4009dfdbe6c", "name":"otdschema11", "message":"Schema created successfully", “code”:200 }

Error codes

The following table lists the error codes that can generate on the failure of the request:

HTTP error codes	Response examples
401 (Invalid Token)	{ "timestamp":"2020-07-01T05:22:29.233Z", "code":401, "messages":["Invalid token."] }
401 (Session Expired)	{ "timestamp":"2020-07-01T05:22:29.233Z", "code":401, "messages":["Session expired."] }
400	Duplicate schema Name { "timestamp":"2020-07-19T13:16:00.450Z", "code":400, "messages":[" A schema with the name otd_schema and path \"\" already exists in project otd_project." ] } Blank or null value for Schema Name { "timestamp":"2020-07-19T13:16:00.450Z", "code":400, "messages":["Schema Name must be specified."] }
500	{ "timestamp":"2020-07-19T13:16:00.450Z", "code":500, "messages":["Create schema failed with following exception."] }

Example of the cURL command

You can also use the following cURL command to create a schema for your HCL® OneTest™ Data project:

curl -X POST 'https://otd-fvt2.nonprod.hclpnp.com/onetest-data/rest/v1/otd/projects/1150/schemas' \ 
--header 'Accept: application/json;charset=utf-8' \ 
--header 'Content-Type: application/json;charset=utf-8' \ 
--header 'Authorization: Bearer xxxxx' \ 
--data-raw '{ 
    "name": "ExampleSchema1", 
    "description": "Schema for creating employee details" 
}'

Have feedback?
Google Analytics is used to store comments and ratings. To provide a comment or rating for a topic, click Accept All Cookies or Allow All in Cookie Preferences in the footer of this page.