Skip to main content

Additional Fields Configuration

Unizo Unified APIs support customization through category-specific additional fields and custom field mapping. This enables you to define and work with extra fields beyond the predefined common data model, while retaining unified API consistency.

Creating Additional Fields​

Step 1: Navigate to Setup Integrations​

  1. Access the Unizo platform
  2. Navigate to Setup Integrations from the left menu
  3. Select the Connectors tab
Unizo Connectors

Setup Integrations - Connectors Tab View

Step 2: Configure Additional Fields​

  1. Select Integration Category: Choose the specific integration category (e.g., Source Code, Ticketing, etc.) where you want to add additional fields
  2. Click Configure Fields: Look for the "Configure Fields" button
  3. Access Field Configuration: This opens the Configure Fields dialog
Unizo Connectors

Configure Additional Fields Dialog Interface

Step 3: Add Additional Fields​

In the Configure Fields dialog:

  1. Browse Data Models: Expand the relevant sections (Example : Ticket, User, Comment etc.)
  2. Review Existing Fields: Each section shows the current number of fields configured
  3. Add New Fields: Click the "+ Add Field" button next to the desired data model
  4. Configure Field Properties:
    • Field name
    • Field type
    • Description
  5. Add Field: Saves your additional field definitions
Unizo Connectors

Adding Custom Fields to Data Models

Mapping Additional Fields​

Step 1: Configure Field Mappings​

After creating additional fields, you need to map them to source system attributes:

  1. Navigate to Connector: Go back to the main connectors view
  2. Select Target Connector: Choose the specific connector (e.g., Jira, ServiceNow, etc.)
  3. Access Data Types: Click the expand icon next to your connector and select "Data Types"
  4. Choose Data Types: Select the data model where you want to add field mappings
Unizo Connectors

Selecting Data Models for Field Mapping

Step 2: Create Field Mappings​

In the Field Mapping interface:

  1. Add Mapping: Click "Configure" to create a new field mapping
  2. Select Source Field: Choose the connector's attribute from the "Source Field" dropdown
  3. Select Target Field: Choose your custom additional field from the "Target Field" dropdown
  4. Validate Mapping: Ensure the data types are compatible
  5. Save Mappings: Click "Save Mappings" to apply the configuration
Unizo Connectors

Field Mapping Configuration and Save Interface

Accessing Additional Fields​

Access additional field mappings through Unified APIs to retrieve your custom data alongside normalized fields.

API Response

Additional field mapping data is automatically accessible in the API responses returned from Unified APIs. No additional parameters are required - once your field mappings are configured and saved, the custom fields will be included in all relevant API responses.

Below is a sample request to the Ticketing Common Model after mapping is complete:

{
  "data": [
    {
      "id": "10700",
      "key": "IT-68",
      "name": "test123 update",
      "assignees": null,
      "creator": "DemoUser",
      "dueDate": null,
      "status": "To Do",
      "description": "test123 update",
      "priority": "High",
      "type": "Task",
      "targetUrl": "https://duser-jsm9790.atlassian.net/rest/api/2/issue/10700",
      "additionalFields": {
        "externalKey": {
          "key": "IT-68"
        }
      },
      "changeLog": null,
      "native_response": {
        // Raw response from source system
      }
    }
  ]
}

The additional fields are stored in the additionalFields object within the response and the mapped attributes from your source systems. In this example, the externalKey field has been mapped and is accessible alongside the common model fields.

For additional support, contact our team at support@unizo.ai.