Create a

Custom Domain

0|Page
When creating a learning instance, you have the option to create a custom
domain.

Prerequisites
Before creating a domain, generate an authorization token. An authorization
token is required to perform a task on IQ Bot.

Procedure

1. Create the Domain JSON structure that you must pass to the Domain
Import REST API.
Contact the Automation Anywhere Service team to get JSON structure specific to
the domain you intend to use.
2. Group the details form with one of the following options.
3. Upload the JSON structure by using the Domain Import REST API endpoint
to create the domain:

Domain Import REST API:

HTTP POST URL: http://localhost:8100/domains/import

Request Headers: Content-Type=application/json; charset=utf-8;
x-authorization=authentication token
POST Payload: Domain Metadata JSON Structure
Response Payload (on success): none.
Response Payload (on error): Default Error Response.

Response HTTP Status Codes

Code Reason Description

200 OK Successful response.
The provided JSON Domain Metadata could not be
400 Bad Input parsed because the JSON was malformed or did not
satisfy one of the Consistency Assertions.
The user is not allowed to access this API. Only users
403 Forbidden
with the AAE_IQ Bot Admin role can access this API.
The Domain name already exists in the system or
409 Conflict there was some other constraint violation when
attempting to insert the data into the database.
Internal Server An unexpected exception occurred when processing
500
Error the domain import.

1|Page
  Call the Domain Import REST API on the same machine on which the IQ
Bot platform is installed.
 Create a unique domain name that does not conflict with any of the
existing domain names on the IQ Bot platform (based on a case-insensitive
comparison).
 Backup your IQ Bot database before creating custom domains so you have
the option to return to the default domain state whenever necessary.

Use tools, for example, Postman, to call the Domain Import REST API to upload
the Domain JSON structure.
An example of a request and response using Postman is provided in the following
screenshot:

1. For the success response Status: 200 OK Time: 228 ms, the
status 200 OK indicates the successful creation of the domain.
2. After creating the domain, log out and log back into the IQ Bot platform.
You now have a domain with targeted languages available on the IQ
Bot platform when you create a learning instance.

For a selected Domain, only those languages that have one or more aliases
available appear in the primary language of files drop-down list.

2|Page