# Connector Metadata Get ## Overview Returns connector metadata information using which OpsHub will register this connector in OpsHub. The features and fields provided here are what users will see on OpsHub UI when configuring integration with this connector. ## API URI This is the URI, OpsHub will execute to call this API: ```bash GET: /connector-metadata ``` ## Response Payload ```json { "enableFeatures": [ "CURRENT_STATE_SYNC_FLAG", "REMOTE_ID_LINK", "TARGET_LOOKUP", "CRITERIA", "MAPPED_DATA_RETRIEVAL" ], "additionalMetadata": { "userSearchOnUserNameSupported": "", "userSearchOnEmailSupported": "" } , "fields": [ { "internalName": "", "displayName": "", "tooltip": "", "required": true, "fieldType": "ENUM", "lookup": { "staticValues": [ { "internalName": "", "displayName": "" } ], "dynamicLookupKey": null }, "defaultValue": null, "validation": null, "fieldOrder": 1, "parent": null, "screens": [ "SYSTEM_CONFIG", "INTEGRATION_SOURCE_CONFIG", "INTEGRATION_TARGET_CONFIG" ] } ] } ``` ## Response Parameters | Parent Parameter | Name | Required | Type | Description | | ------------------ | ----------------------------- | ----------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | enableFeatures | True | ENUM |

List of features to be enabled in OIM:

CURRENT\_STATE\_SYNC\_FLAG: A flag to enable integration sync only latest entity state. Applies only for entity types with "pollerType": "ENTITY\_WISE\_HISTORY". Refer to Sync only current state for details.
REMOTE\_ID\_LINK: Stores id and link of an entity of other system. To form the link using a URL other than connector's server URL, enter in "Base URL for Remote Link" field. See Remote Id and Link.
TARGET\_LOOKUP: Search entity in target system before sync. See Target Lookup.
CRITERIA: Sync only subset of entities meeting criteria/condition. See Criteria Configuration.
MAPPED\_DATA\_RETRIEVAL: Enables "fetch mapped data only" feature if end system supports fetching specific fields.

| | additionalMetadata | | False | | | | | userSearchOnUserNameSupported | False | boolean |

Does the connector support user search based on userName?
Default is false. If connector allows search by username, provide as true.

| | | userSearchOnEmailSupported | False | boolean |

Does the connector support user search based on email?
Default is false. If connector allows search by email, provide as true.

| | fields | | True | | | | | internalName | True | string | Internal name of the user input. Must be unique. E.g., `authType`, `userName`. | | | displayName | True | string | Display name shown in OpsHub UI. E.g., `Authentication Type`, `User Name`. | | | tooltip | False | string | Help text for the field. E.g., “Provide a URL to connect to end system. Format: Example: . | | | required | True | boolean | Is the user input mandatory? `true` / `false`. | | | fieldType | True | ENUM |

Input types:
- TEXT\_BOX
- TEXT\_AREA
- DROP\_DOWN
- PASSWORD
- RADIO\_BUTTON
- CHECKBOX
- URL
- EMAIL
- NUMERIC
- MULTI\_SELECT\_DROP\_DOWN\_WITH\_CHECKBOX
- JSON
- XML

| | Fields.lookup | | False | | For any DROP\_DOWN type inputs. The user needs to provide lookup values to show the options in drop down | | | staticValues | Conditional | List of Objects | Static values for dropdown. E.g., “1=Basic,2=Token Based”. Order determines UI display order. | | | staticValues.internalName | | string | Internal id of lookup. E.g., 1, 2, 3. | | | staticValues.displayName | | string | Display name in dropdown. E.g., Basic, Token Based. | | | dynamicLookupKey | Conditional | ENUM |

Dynamic lookup options:
- ALL\_SYSTEM: List of all the systems that exists in OIM
- ALM\_SYSTEM: List of all the ALM systems created by user in OIM. This will not fetch any SCM system
- TIME\_ZONE: Pre-defined list of available time zones
- ENTITY\_FIELDS: Dynamically displays the list of available fields of an entity from end system API. This type of dynamic lookup is used when list of available fields for an entity is to be displayed.
- DATABASE\_TYPE: List of all database types supported in Database System.

| | Fields. validation | | False | | Validation to be applied on any textual field | | | name | False | string | Name of validation. E.g., “System Version Validation”. | | | regex | False | string | Regex to validate field value. E.g., `[1-9]{1,2}\.[0-9]{1,2}\.[0-9]{1,2}`. | | | failureMessage | False | string | Message shown if validation fails. E.g., “Please provide valid version in form of x.y.z”. | | fields | | | | | | fields | fieldOrder | True | number | UI order of field. | | parent | | False | |

It’s to support hierarchy of the fields.
E.g., ‘authType’ can be parent of ‘userName’, ‘password’ and ‘token’

| | | internalName | False | string |

Internal name of the parent field.
E.g., 'issueType' is a built-in field. There is no need to provide metadata configuration for 'issueType' field in JSON.
E.g., For username or password field, auth\_type can be the internalName for parent field.

| | | fieldValues | False | string |

Internal value of the parent field. Current field will only be loaded if parent field’s value matches the given value.
E.g., If authType has values “1=Basic,2=Token Based”, provide 1 to select Basic as parent field value.

Some fields can be loaded only if a particular parent field value is selected.
E.g., If authType is parent of userName, password, and token fields:
- password will only be loaded if authType value is Basic.
- token will only be loaded if authType value is Token Based.

| | | fieldRegex | False | string | Regex controlling visibility of current field based on parent field value. | | fields | | | | | | | screens | True | ENUM |

List of screens where this field should be visible:
- SYSTEM\_CONFIG: System configuration screen
- INTEGRATION\_SOURCE\_CONFIG: Advanced integration config when connector is source
- INTEGRATION\_TARGET\_CONFIG: Advanced integration config when connector is target

| Example: ```json { "enableFeatures": [ "CURRENT_STATE_SYNC_FLAG", "REMOTE_ID_LINK", "TARGET_LOOKUP", "CRITERIA", "MAPPED_DATA_RETRIEVAL" ], "fields": [ { "internalName": "authType", "displayName": "Authentication Type", "tooltip": "Authentication Type", "required": true, "fieldType": "DROP_DOWN", "lookup": { "staticValues": [ { "internalName": "1", "displayName": "Basic Authentication" } ], "dynamicLookupKey": null }, "defaultValue": null, "validation": null, "fieldOrder": 1, "parent": null, "screens": [ "SYSTEM_CONFIG", "INTEGRATION_SOURCE_CONFIG", "INTEGRATION_TARGET_CONFIG" ] }, { "internalName": "userName", "displayName": "Authentication User", "tooltip": "Authentication User", "required": true, "fieldType": "TEXT_BOX", "lookup": null, "defaultValue": null, "validation": null, "fieldOrder": 2, "parent": { "internalName": "authType", "fieldValues": [ "1" ], "fieldRegex": null }, "screens": [ "SYSTEM_CONFIG", "INTEGRATION_SOURCE_CONFIG", "INTEGRATION_TARGET_CONFIG" ] }, { "internalName": "password", "displayName": "Authentication Password", "tooltip": "Authentication Password", "required": true, "fieldType": "PASSWORD", "lookup": null, "defaultValue": null, "validation": null, "fieldOrder": 3, "parent": { "internalName": "authType", "fieldValues": [ "1" ], "fieldRegex": null }, "screens": [ "SYSTEM_CONFIG", "INTEGRATION_SOURCE_CONFIG", "INTEGRATION_TARGET_CONFIG" ] } ] } ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.opshub.com/v7.209/connector-sdk-index/sdk-connector-apis/connector-metadata-get.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.