# Entity Type Get ### Overview This API describes the entity type in detail for OpsHub to be able to integrate various basic and complex data for a given entity type. > **Note**: It is important to return a correct response for this API as OpsHub relies heavily on these inputs to handle multiple connector tasks automatically. ### API URI This is the URI OpsHub will execute to call this API: ```bash GET: /entity-types/{entityTypeId}?projectId= ``` ### URI Parameters | Name | In | Required | Type | Description | | ------------ | ----- | -------- | ------ | --------------------------------------------------------------------------------------------------------------------------------- | | entityTypeId | path | True | String | ‘id’ of entity type returned as response of Entity Type – List API | | projectId | query | True | String | Project id for which entity type details need to be returned. ProjectId here will be the same as ‘id’ sent as part of `/projects` | ### Response Payload ```json { "multiStepUpdate": "NO_SUB_STEPS, STATIC_SUB_STEPS, DYNAMIC_SUB_STEPS", "recovery": { "type": "FIELD_BASED, COMPARISON_BASED, HISTORY_BASED", "fieldName": "// If FIELD_BASED, then id of the field to store last update date" }, "history": { "type": "FIELD_BASED, FULL_STATE_BASED", "revisionDateFormat": "dd/MM/YYYY’T’hh:mm:ss.SSSz", "isRevisionIdNumeric": "true/false | datatype: boolean", "revisionUserDataType": "USERNAME_AS_USER, EMAIL_AS_USER", "separateHistoryApis": "ATTACHMENTS, COMMENTS, LINKS", "sortableFields":"CREATED_UPDATED_TIME, ENTITY_ID, REVISION_ID" }, "enitytScope": { "additionalScopeFieldName": "field id used as additional scope" }, "entityWebUrl": { "baseUrl": "https://example.com/", "trailingTemplate": "browse/{0}/{1}", "substitutes": { "0": "field id of the field whose value need to be first replacement", "1": "field name of second replacement field" } }, "isFieldIdConstantAcrossProjects": "true/false | datatype: boolean", "isInternalValueExistForLookupField": "true/false | datatype: boolean", "isUpdateAvailable": "true/false | datatype: boolean", "waitTimeInMillisIfApiResponseDelayed": "Max delay in API response in milli seconds. | datatype: number", "searchEntityInfo": { "sortableFields": "CREATED_UPDATED_TIME, ENTITY_ID, REVISION_ID", "isGroupingSupported": "true / false", "isSearchPossibleOnAnyField": "true / false", "isCriteriaInSystemNativeFormat": "true / false", "dateTimeFormat": "dd/MM/YYYY’T’hh:mm:ss.SSSz", "queryFieldNameInfo": { "entityIdFieldName": "entity id field id", "entityTypeIdFieldName": "entity type field id", "projectIdFieldName": "project id’s field id", "createdDateFieldName": "created date’s field id", "updatedDateFieldName": "updated date’s field id", "createdByFieldName": "created By’s field id" }, "batchSizeForInQuery": "number of entities that can be passed in 'IN' or 'OR' query" }, "fieldNameInfo": { "entityIdFieldName": "field id of unique and uneditable entity primary id field", "entityTitleFieldName": "field id for entity title", "entityDisplayIdFieldName": "field id of field that has entity display id (id any)", "entityTypeIdFieldName": "field id for entity type", "projectIdFieldName": "field id of field that contains project info for entity", "createdDateFieldName": "field id of Created date field", "updatedDateFieldName": "field id of updated date field", "createdByFieldName": "field id of created By field", "updatedByFieldName": "field id of updated By field", "archiveMetadata" : { "archivedByFieldName": "field id of archived By field", "isArchivedFieldName": "field id of is Archived field" } }, "fields": [ { "id": "unique id or key for each field", "name": "Field name", "dataType": "TEXT, HTML, WIKI, LOOKUP, DATE, DATE_TIME, DATE_STRING, BOOLEAN, NUMBER, USERNAME_AS_USER, TIME_UNIT, EMAIL_AS_USER, RTF, HYPERLINK, TEST_STEP, PARAMETER, REFERENCE, IMAGE, HIERARCHY", "isMandatory": "true/false | datatype: boolean", "isMultiSelect": "true/false | datatype: boolean", "isReadOnly": "true/false | datatype: boolean", "isHistorySupported": "true/false | datatype: boolean", "userMentionSupported": "true/false | datatype: boolean", "entityMentionSupported": "true/false | datatype: boolean", "timeUnit": "MILLISECOND, SECOND, MINUTE, HOUR, DAY", "dateFormat": " yyyy-MM-dd or yyyy-MM-dd’T’HH:mm:ss.SSSz", "canBeSetAtEntityCreateTime": "true/false | datatype:boolean", "updateStepNumber": "// Number starting with 1,2,3", "referenceFieldMetadata": { "referencedEntityTypeId: "id of the entity type which is referenced through field" "idFieldName": "id field name which stores id or URL of the referenced entity in Entity - GET API and History - List API for base entity" "referenceUrl": { "baseUrl": "https://example.com/", "trailingTemplate": "browse/{0}/{1}", "substitutes": { "0": "field id of the field whose value need to be first replacement", "1": "field id of the field whose value need to be second replacement" } } "titleFieldName": "title field name which stores title or equivalent field of the referenced entity in the Entity - GET API and History - List API for base entity" } }, { "id": "unique id or key for each field", "name": "Field name", "dataType": "TEXT, HTML, WIKI, LOOKUP, DATE, DATE_TIME, DATE_STRING, BOOLEAN, NUMBER, USERNAME_AS_USER, TIME_UNIT, EMAIL_AS_USER, RTF, HYPERLINK, TEST_STEP, PARAMETER, REFERENCE, IMAGE, HIERARCHY", "isMandatory": "true/false | datatype: boolean", "isMultiSelect": "true/false | datatype: boolean", "isReadOnly": "true/false | datatype: boolean", "isHistorySupported": "true/false | datatype: boolean", "userMentionSupported": "true/false | datatype: boolean", "timeUnit": "MILLISECOND, SECOND, MINUTE, HOUR, DAY", "dateFormat": "yyyy-MM-dd or yyyy-MM-dd’T’HH:mm:ss.SSSz", "canBeSetAtEntityCreateTime": "true/false | datatype:boolean", "updateStepNumber": "// Number starting with 1,2,3", "referenceFieldMetadata": { "referencedEntityTypeId: "id of the entity type which is referenced through field" "idFieldName": "id field name which stores id or URL of the referenced entity in Entity - GET API and History - List API for base entity" "referenceUrl": { "baseUrl": "https://example.com/" "trailingTemplate": "browse/{0}/{1}", "substitutes": { "0": "field id of the field whose value need to be first replacement", "1": "field id of the field whose value need to be second replacement" } } "titleFieldName": "title field name which stores title or equivalent field of the referenced entity in the Entity - GET API and History - List API for base entity" } } ], "comments": { "userMentionSupported": "true/false | datatype: boolean", "entityMentionSupported": "true/false | datatype: boolean", "commentBodyDataType": "TEXT, HTML, WIKI", "commentIdDataType": "NUMBER, TEXT", "createdUpdatedByFieldDataType": "USERNAME_AS_USER, EMAIL_AS_USER" "htmlReplacementForNewLine": "
or \n or null", "delayInCommentUpdateTimeInMillis": 2000, "createUpdateDateFormat": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "typesOfComments": [ "Private", "Public", "etc." ], "fieldNameInfo": { "idFieldName": "Field name of comment id as it is received in API by end system", "titleFieldName": " Field name of comment title as it is received in API by end system ", "bodyFieldName": " Field name of comment body as it is received in API by end system ", "createdDateFieldName": " Field name of comment created date as it is received in API by end system ", "updatedDateFieldName": " Field name of comment updated date as it is received in API by end system ", "createdByFieldName": " Field name of comment created by as it is received in API by end system ", "updatedByFieldName": " Field name of comment updated by as it is received in API by end system ", "commentTypeFieldName": " Field name of comment type as it is received in API by end system " } }, "attachments": { "updateSupported": "true/false | datatype: boolean", "deleteSupported": "true/false | datatype: boolean", "historySupported": "true/false | datatype: boolean", "createUpdateDateFormat": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "typesOfAttachments": [ "Internal", "External", "etc." ], "fieldNameInfo": { "idFieldName": " Field name of attachment id as it is received in API by end system ", "contentUriFieldName": " Field name of attachment content URI as it is received in API by end system ", "renderUriFieldName": " Field name of attachment render URI as it is received in API by end system ", "fileNameFieldName": " Field name of attachment file name as it is received in API by end system ", "contentTypeFieldName": " Field name of attachment content type as it is received in API by end system ", "contentLengthFieldName": " Field name of attachment length as it is received in API by end system ", "createdOrUpdatedDateFieldName": " Field name of attachment updated as it is received in API by end system ", "createdByFieldName": " Field name of attachment created by as it is received in API by end system ", "attachmentTypeFieldName": " Field name of attachment type as it is received in API by end system ", "fileCommentFieldName": " Field name of the attachment file comment as it is received in API by end system " } }, "inlineFiles": { "deleteSupported": "true/false | datatype: boolean", "inlineFileStorageType": "ENTITY_LEVEL_STORAGE | EXTERNAL_STORAGE", "inlineFileUrlPrefix": "" }, "links": { "deleteSupported": "true/false | datatype: boolean", "historySupported": "true/false | datatype: boolean", "createUpdateDateFormat": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "rank": { "rankType": "FLAT_SINGLE | FLAT_MULTIPLE | HIERARCHY_SINGLE | HIERARCHY_MULTIPLE", "supportedRankOperations": [ "MOVE_BEFORE", "MOVE_AFTER", "LAST_IN_LIST", "MOVE_BULK_AFTER" ], "rankFieldName": "If entity stores the rank info in a field, provide that field name.", "rankScope": { "template": "{0}::{1}", "substitutes": { "0": "field name of the field whose value needs to be replacement for 0", "1": "field name of the field whose value needs to be replacement for 1" } } }, "linkTypes": [ { "linkType": "", "reverseLinkType": "", "isMultiLinkAllowed": "true/false | datatype: boolean", "isLinkMandatory": "true/false | datatype: boolean", "isBulkLinkingSupported": "true/false | datatype: boolean", "isExternalLink": "true/false | datatype: boolean" } ], "fieldNameinfo": { "linkTypeFieldName": " Field name of link type (parent, child, related etc.) as it is received in API by end system ", "linkedEntityIdFieldName": " Field name of linked entity id as it is received in API by end system ", "linkedEntityTypeFieldName": " Field name of linked entity type as it is received in API by end system ", "linkedEntityScopeIdFieldName": "linkedEntityScopeId | TODO: Revisit this", "createdDateFieldName": " Field name of link created date as it is received in API by end system ", "createdByFieldName": " Field name of link created by user as it is received in API by end system ", "linkCommentFieldName": " Field name of link comment as it is received in API by end system ", "externalLinkUrlFieldName": " Field name of link external URL as it is received in API by end system ", "isExternalLinkFieldName": " Field name of field which says if it’s an external link or not, as it is received in API by end system " } }, "userMention": { "userMentionDataType": "USERNAME_AS_USER / EMAIL_AS_USER", "mentionDetails": [ { "fieldDataType": "HTML", "selectorOrRegex": ["Example: a[href]"], "mentionTemplate": "Example: ${displayName} ", "userDataRegex": "", "userDataAttributeName": "Example: href / rel / data-mention" }, { "fieldDataType": "WIKI", "selectorOrRegex": "Example: [~ohusermention:(.*?)]", "mentionTemplate": "Example: [~accountId:${username}]" }, { "fieldDataType": "TEXT", "selectorOrRegex": "Example: @OH_USER@ohusermention:(.*?)@OH_USER@", "mentionTemplate": "Example: ${username} <${email}>" } ] }, "entityMention": { "mentionDetails": [ { "fieldDataType": "HTML", "selectorOrRegex": ["Example: a[href]"], "mentionTemplate": "Example: ${displayName} ", "entityIdAttribute": { "dataAttributeName": "href", "dataRegEx": "/browse/([A-Z_a-z0-9-]+)" }, "entityTypeAttribute": { "dataAttributeName": "href", "dataRegEx": ".*\\?detail=/(.*?)(?=/\\d+)" }, "entityProjectAttribute": { "dataAttributeName": "href", "dataRegEx": ".*([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})/_workitems/edit/.*" } } ], "entityURLDetails": [ { "entityWebURLMatcher": "a[href~=/browse/[A-Z_a-z0-9-]+-\\d+]", "entityIdDataSelector": ".*\\/browse/([A-Za-z0-9-]+-\\d+)]" } ] } } ``` > **Internal note:** For attachment, comment, link: `readSupported`, `writeSupported` can be derived from sync direction of entityType. ## Response Parameters | Parent Parameters | Name | Required | Type | Description | | ----------------- | -------------------- | ----------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | multiStepUpdate | True | Enum |

OpsHub uses this flag to identify if all fields can be updated in single update entity call or multiple update entity calls are required. For example: If all the fields under fields can be updated in single API call in end system, then pass NO\_SUB\_STEP. But let’s say, if the end system has a separate API to transition entity from one state to another, then connector can pass STATIC\_SUB\_STEPS or DYNAMIC\_SUB\_STEPS depending on need. If ‘DYNAMIC\_SUB\_STEPS‘ is being passed, then /entities/{entityTypeId}/sub-steps-for-update API is mandatory to implement.

\* NO\_SUB\_STEP: All the fields of an entity can be updated in single update entity API call.

\* STATIC\_SUB\_STEPS: Step number of the field to be updated is predefined. So, every time when multiple fields are updated in single update, based on updateStepNumber of field, the order of field can be decided for the update.

\* DYNAMIC\_SUB\_STEPS: The order in which the fields can be passed to the end system for the update is dynamically decided based on field value. E.g., if the entity is getting closed along with few other fields getting updated. In this case, other fields must be updated first and then entity status should be updated to closed.

| | **recovery** | | True | | | | | Type | True | Enum |

Helps OpsHub determine if the given transaction has already taken place in failure and recovery scenarios.

HISTORY\_BASED: (Preferred) Entity History – Get (/entities/{entityTypeId}/history) must be implemented, if this is passed. OpsHub will use the entity revision to identify if a given transaction was completed or not.
FIELD\_BASED: Add a custom field of type text to end system (E.g., oh\_last\_update) to perform recovery. Ensure this field is passed under ‘fields’ of this API.

COMPARISON\_BASED: This is a less reliable recovery mechanism as compared to HISTORY\_BASED or FIELD\_BASED. OpsHub compares last entity state saved in its database with current state in end system, to determine if last transaction was completed or not.

Select this recovery mechanism if the pollerType for entity type is NON\_TIME\_BASED.

| | | fieldName | True, if recovery type=FIELD\_BASED | String | In case of FIELD\_BASED recovery, the field id of the custom field can be used by OpsHub for storing recovery flags. (E.g., oh\_last\_update). Note: This field should not be updated by other users in the end system. | | **History** | | False | | Pass this parameter, if the pollerType for entity type is ENTITY\_WISE\_HISTORY | | | Type | True | Enum |

How the end system returns entity history?

FIELD\_BASED: In a given revision, the old and new values are obtained only for those fields of an entity that were changed in a given transaction.
FULL\_STATE\_BASED: For a given revision, the end system returns the entity field state for all fields as of that revision.

| | | revisionDateFormat | True | String | Date format for the field, which contains revision date time | | | isRevisionIdNumeric | True | Boolean | When true, all the revision sorting will happen considering numeric value of revision id. When false, all the revision sorting will happen considering string value of revision id. Default will be false | | | revisionUserDataType | True | Enum |

Data type of the revision user.

EMAIL\_AS\_USER: When the user’s email is provided in the revision user field.

USERNAME\_AS\_USER: When the username is provided in the revision user field.

| | | separateHistoryApis | False | String |

This is an optional input. Provide only if the end system has a separate history API for attachments, comments and/or links.
If separate history APIs is available for attachments, comments and/or links, provide the following as per API availability:

ATTACHMENTS: When separate history API for attachments is available.

COMMENTS: When separate history API for comments is available.

LINKS: When separate history API for links is available.

| | | sortableFields | False | Set`` |

Send set of fields for which end system supports sorting on history API. The fields can be sent in any order in the list. Connector should sort all the fields provided in the set.
Example:
If end system supports sorting on ENTITY\_ID, CREATED\_UPDATED\_TIME and REVISION\_ID: sortableFields = {CREATED\_UPDATED\_TIME, ENTITY\_ID, REVISION\_ID}\
\
`If end system supports sorting only on CREATED_UPDATED_TIME: `sortableField={CREATED\_UPDATED\_TIME}.
In case of history, CREATED\_UPDATED\_TIME is same as REVISION\_DATE\_TIME.

|
Parent ParameterNameRequiredTypeDescription
entityScopeFalseIf entity scope is decided based on only entity type and any additionalScopeField (like a project) is not required, this field can be set to null.
additionalScopeFieldNameTrue, if entityScope is passed.BooleanIf entity scope is decided based on only entity type, this field can be set to null.
If entity scope is dependent on entity type as well as any other field of the entity (e.g., projectId, workspaceId, or domainId), provide that field name of the entity.
Ensure that this field name matches one of the field names in “entityFieldNameInfo”.
entityWebUrlFalsePass this if you want the Remote Entity Link feature enabled for the connector. Otherwise, do not include entityWebURL in response.
baseUrlTrueStringString containing the base URL of the end system.
e.g., if the actual URL format is "https://example.com/browse/{0}/{1}" then set baseUrl as "https://example.com/" and trailingTemplate as "browse/{0}/{1}".
This URL is used to form the Remote Link. If value for the field "Base URL for Remote Link" is not given in the system configuration form, the baseUrl will be used by default to form Remote Link.
trailingTemplateTrueStringString template containing the trailing part of the URL format.
Provide all the dynamic parts in the URL as substitute numeric variables, e.g., {0}, {1} etc.
e.g., If the projectId is 101 and entity is 10001, the base URL is https://example.com/ and trailingTemplate is browse//.
So, the actual web URL will be "https://example.com/browse/101/10001".
substitutesTrueListMap containing all the substitute numeric parameters to the replacement field name of the entity.
e.g., {"0": "projectIdFieldName", "1": "entityIdFieldName"}

In the “trailingTemplate":
* The value of parameter {0} will be replaced with actual value coming in field project id for the entity.
* The value of parameter {1} will be replaced with actual value coming in entity id for the entity.
Ensure that this field name matches one of the field names in “fieldNameInfo”.
isFieldIdConstantAcrossProjectsTrueBooleanSet to 'True' if the field id for the same field is same in different projects; else, set to 'False'.
e.g., If for a field with the display name 'Priority', field id in Project A is '100' and for Project B is '101', then send 'False'.
On the other hand, if the field id is the same (say 'priority' or '100') for all projects, then send 'True'.

If this is 'True', in FieldsMeta, we will use Field Id; otherwise, we will use Field Name.
isInternalValueExistForLookupFieldBoolean

Set to 'True' if the lookup fields have different internal and display values.
Set to 'False' if the lookup fields have only one value, the display value.

Example 1:

"isInternalValueExistForLookupField": true
 [ { "id": "low", "value": "Low" }, { "id": "medium", "value": "Medium" }, { "id": "high", "value": "High" } ]


Here, priority field has values having different internal value and display value.

Example 2:

"isInternalValueExistForLookupField": false, [ { "id": "Low", "value": "Low" }, { "id": "Medium", "value": "Medium" }, { "id": "High", "value": "High" } ]

Here, the priority field does not have a different value for internal value.

| Parent Parameter | Name | Required | Type | Description | | ---------------------------------------- | ---- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **isUpdateAvailable** | | False | Boolean |

Set to 'True' if update is possible on the entity.
Set to 'False' if entity is create only.

| | **waitTimeInMillisIfApiResponseDelayed** | | False | Number |

In some systems, there is a delay in API returning updated data in response.

e.g., If an entity is updated:
\* If within next second we try to fetch list of entities, the system might not return the last updated entity.
But if we get the list of updated entities after 2 seconds, the system will start returning the entities.
This delay might be due to indexing in the end system.

\* Similarly, for history based systems, if we update an entity:
The last revision might not be available in the audit API within a second or two.
But if we query the revisions after 3 seconds, the system will start returning the revision.
This delay might be due to system inserting audit records separately than the actual entity update.

OIM handles this type of delays for update up to 2 seconds (2000 milliseconds).
\* If the end system has delay of up to 2 seconds, the value can be kept null.
\* If the end system has delay of more than 2 seconds, provide the maximum delay value in milliseconds in this field.

|
Parent ParameterNameRequiredTypeDescription
searchEntityInfoTrueAll the metadata for querying end system to search entities.
sortableFieldsFalseSet<Enum>Send set of fields for which end system supports sorting. For searchEntityInfo no need to pass REVISION_ID in sortableFields set.
E.g. If end system supports sorting on both ENTITY_ID and CREATED_UPDATED_TIME,
sortableFields = {ENTITY_ID, CREATED_UPDATED_TIME}
isGroupingSupportedTrueBooleanTrue (Preferred) if end system support order by for both created/updated time and entity id fields, otherwise false. If it is false, OpsHub will sort the results.
isSearchPossibleOnAnyFieldTrueBooleanIf criteria storage needs to be in the end system, then only set the field to true.
The field selected for end system criteria should be queryable. If that's true, pass true here.
To get more details on end system criteria storage, refer [[ Integration_Configuration#Criteria_Configuration
isCriteriaInSystemNativeFormatTrueBooleanSend 'True' if configured criteria in OIM will be in the end system native query format.
If 'Yes', the criteria can be the exact query that the end system supports.
If 'No', the criteria should be OpsHub standard JSON format query.
dateTimeFormatTrueStringDate time format supported within the query.
E.g., (where updatedDate > ‘2021-12-31 00:00:00’). Here, dateTimeFormat should be set as yyyy-MM-dd HH:mm:ss
queryFieldNameInfoFalse

Query field names should be provided for entity id, entity type id, project id, created date, updated date and created by field.
If the query field name for the above fields is the same as their field id given in 'fieldNameInfo', then set this field as 'Null'. Otherwise, provide the end system field names used for querying. If these field names are provided, they will be used to generate queries. Here is a sample format of data to be passed under this parameter:

"entityIdFieldName": "entity id field id",
  "entityTypeIdFieldName": "entity type field id",
  "projectIdFieldName": "project id’s field id",
  "createdDateFieldName": "created date’s field id",
  "updatedDateFieldName": "updated date’s field id",
  "createdByFieldName": "created by field id"
batchSizeForInQueryFalseIntegerNumber of entities end system supports in "IN" or "OR" query. Default will be 250.
E.g. for IN query: entityId IN (1, 2, 3)
E.g. for OR query: (entityId = 1) OR (entityId = 2) OR (entityId = 3)
Parent ParameterNameRequiredTypeDescription
fieldNameInfoTrueProvide the end system field details for all the fields that need to be integrated
For below fields, specify name of the field under which OpsHub will get or send given information for an entity from SDK
entityIdFieldNameTrueStringName of the field that contains a unique and uneditable primary id of the entity
entityTitleFieldNameFalseStringName of the field that contains title of the entity (For e.g. name, title, summary). Provide this input only if field is to be synchronized as reference field.
entityDisplayIdFieldNameTrueStringName of the field that contains a user friendly id of the entity (For e.g. in Jira Issue Key will be entity display field and Issue Id will be entity id)
entityTypeIdFieldNameTrueStringName of the field that contains type (Requirement, Bug, etc.) of the entity
projectIdFieldNameTrueStringName of the field that contains the project id in which the entity exists
createdDateFieldNameTrueStringName of the field that contains the created date of the entity
updatedDateFieldNameTrueStringName of the field that contains the last updated date of the entity
createdByFieldNameTrueStringName of the field that contains the created by user details of the entity
updatedByFieldNameTrueStringName of the field that contains the updated by user details of the entity
archiveMetadataFalseObject

Pass this metadata if the entity supports archive operation.

"archiveMetadata": {
  "archivedByFieldName": "Name of the field that contains Archived by User details of the entity",
  "isArchivedFieldName": "Name of the field that contains If Entity is Archived details of the entity"
}
Parent ParameterNameRequiredTypeDescription
fieldNameInfo.fieldsTrueDetails of all the fields that user want to integrate via SDK
idTrueStringInternal name of the field. Always pass internal name only even if field meta is different across projects. OIM will handle the different internal names for the field having the same display name in different projects
nameTrueStringDisplay name of the field
dataTypeTrueEnumData Type of the field which OIM understands. TEXT, HTML, WIKI, LOOKUP, DATE, DATE_TIME, DATE_STRING, BOOLEAN, NUMBER, USERNAME_AS_USER, TIME_UNIT, EMAIL_AS_USER, RTF, HYPERLINK, TEST_STEP, PARAMETER, REFERENCE, IMAGE, HIERARCHY
For example, the end system data type is 'string' but for OIM it's 'TEXT'. So, set dataType as 'TEXT'
additionalFieldMetaDataFalseObject

This property can be used to set additional meta data of field.
For example, the 'Test Step' field is a complex field with nested fields, such as 'Description,' 'Expected Result,' etc. If the 'Description' is of the 'HTML' type, then set the richTextDataType of the 'Test Step' field to 'HTML' inside 'additionalFieldMetaData'.

"additionalFieldMetaData" : {
  "richTextDataType" : "An additional meta of field to determine rich text data type of field."
}

Example:
{
  ...,
  "additionalFieldMetaData":{
    "richTextDataType":"HTML"
  },
  ...,
}
timeUnitTrueIf the dataType is TIME\_UNIT, this field is required. "MILLISECOND, SECOND, MINUTE, HOUR, DAY"
dateFormatTrueIf the dataType is DATE, this field should only have the date format. E.g., yyyy-MM-dd
If dataType is DATE\_TIME, this field should have date time format. E.g., yyyy-MM-dd HH:mm:ss.SSS z
isMandatoryTrueBooleanSend true if the field is mandatory, otherwise send false
isMultiSelectTrueBooleanSend true if the field is of type lookup or user and multiple values can be selected, otherwise send false
isReadOnlyTrueBooleanSend true if the field is read only and cannot be written, otherwise send false
isHistorySupportedTrueBooleanSend true, if for /entity-types request, pollerType is ‘ENTITY\_WISE\_HISTORY’ and end system tracks changes on this field, under revisions. E.g., if the Entity Title/Name is updated and the end system track history like Name updated from ‘oldName’ to ‘New title’, then send True. Send false, otherwise.
userMentionSupportedFalseBooleanSend true if users can be mentioned (@Smith) in the given field, otherwise return false
entityMentionSupportedFalseBooleanSend true if entities can be mentioned (@entity) in the given field, otherwise return false
canBeSetAtEntityCreateTimeTrueBooleanSend true if the field value can be set at the time of entity creation, otherwise false
updateStepNumberFalseNumberRequired only if you are returning ‘STATIC\_SUB\_STEPS’ in ‘multiStepUpdate’ from this API. Step number in which the field can be updated. Field group number – where group is for update groups. Number starting with 1,2,3....
For example, if there is separate API to transition Status from one state to another and all other fields can be updated in single update request to the end system, then send 1 for all fields except Status. For Status, send 2. For any update request, OpsHub will call update entity SDK API twice, once with payload for all other fields and second time only with Status field

If the end System allows the Entity Type movement and Project movement then this will be required if you are returning 'STATIC\_SUB\_STEPS' or 'DYNAMIC\_SUB\_STEPS' in 'multiStepUpdate' from this API:

updateStepNumber for entityTypeIdFieldName:
- "-3": In case the end system have different API for Entity Type and Project Movement. Or the end system doesn't support Project Movement.
- "-6": In case the end system have same API for Entity Type and Project Movement.

updateStepNumber for projectIdFieldName:
- "-2": In case the end system have different API for Project and Entity Type Movement. Or the end system doesn't support Entity Type Movement.
- "-6": In case the end system have same API for Entity Type and Project Movement.

If no metadata for the updateStepNumber for either entityTypeIdFieldName or projectIdFieldName is provided then by default they will be treated as having separate API for Entity Type and Project Movement.
In case of different updateStepNumber of entityType and project, If both entityType and project movement is found supported then the order for update operation will first be Project Movement and then Entity Type movement.
referenceFieldMetadataFalseObject

Pass this metadata if the field is to be synchronized as reference field.

referenceFieldMetadata: {
  referencedEntityTypeId: id of the entity type which is referenced through field. For e.g., if in Bug Entity, release is a reference field, provide id of the release entity type.

  idFieldName: Provide the field name which stores id or URL of the referenced entity in Entity - GET API and History - List API for base entity. If end system provides both id and url of the referenced entity, provide the name of the field which stores id.

  Example 1: If the response of the getting Bug API is as follows:
  {
    "id": "391",
    "fields": {
      "release": {
        "releaseId": "100",
        "description": "This release addresses major customer escalations and some critical defects",
        "releaseName": "Release 1",
        "archived": false
      }
    }
  }
  Here, id field name of the referenced entity is "releaseId".

  Example 2: If the response of getting base entity API is as follows:
  {
    "bugRef": "",
    "fields": {
      "release": {
        "releaseRef": "",
        "description": "This release addresses major customer escalations and some critical defects",
        "releaseName": "Release 1",
        "archived": false
      }
    }
  }

  Here, id field name of the referenced entity is "releaseRef".

  referenceUrl: Provide this input if end system's API provides link to url of the referenced entity instead of id. If end system provides both id and url of the referenced entity, do not include referenceUrl in response.
  For example 2, if link to url is: "" then referenceURl.baseUrl: ,  referenceURl.trailingTemplate: {0}/{1}/{2}
  And referenceUrl.substitutes would be {0, "projectIdFieldName", 1, "entityTypeIdFieldName", 2, "entityIdFieldName"}

  titleFieldName: Provide the field name which stores title or equivalent field of the referenced entity in the Entity - GET API and History - List API for base entity. If end system's APIs' do not have name of the referenced entity in Entity - GET API and History - List API, set this input to null.
  For example 2, titleFieldName would be releaseName.
}
Parent ParameterNameRequiredTypeDescription
commentFalsePass this parameter if you want to integrate comments for a given entity type. Otherwise, do not send the comment parameter at all. If this parameter is passed, SDK must implement all the Comment APIs.
fieldNameInfoTrueObject

If the comment parameter is sent back, then it is mandatory to send fieldNameInfo. The user needs to send the field names as they will be sent by SDK to OpsHub when reading comments and from OpsHub to SDK when adding comments. OpsHub will try to find the given information in the field name specified as part of the data sent here.

{
  "idFieldName": "id",
  "titleFieldName": "title",
  "bodyFieldName": "body",
  "createdDateFieldName": "created",
  "updatedDateFieldName": "updated",
  "createdByFieldName": "createdBy",
  "updatedByFieldName": "updatedBy",
  "commentTypeFieldName": "commentType"
}
userMentionSupportedFalseBooleanSend true if the user mention supported within comments; otherwise, false.
entityMentionSupportedFalseBooleanSend true if the user mention supported within comments; otherwise, false.
commentBodyDataTypeTrueEnumTEXT, HTML, WIKI
commentIdDataTypeTrueEnumNUMBER, TEXT
createdUpdatedByFieldDataTypeFalseEnumPass this parameter if you need user data while creating comment. Example, you want to create comment with same user as source endpoint. If you require username send USERNAME_AS_USER, if you require email address send EMAIL_AS_USER.
htmlReplacementForNewLineTrueStringExact value for new line character in the comment.
Possible values are: ‘
’, ‘\n’ or null.
createUpdateDateFormatTrueStringDate format for created and updated dates of the comment.
delayInCommentUpdateTimeInMillisFalseNumberExpected delay between entity update time and comment update time.
There are systems in which comment update is delayed after entity update time. In such systems, identify the maximum delay that may be there in comment update time after entity update time.
If there is no delay in the system, the below value can be set as 0.
If there is delay of let say up to 2 seconds, set the value to 2000 (in millis). If the delay is up to 5 seconds, set the value to 5000.
typesOfCommentsTrueList<String>The supported list of comment types. E.g., Internal, External, Work Notes, Additional etc. OpsHub will display these comment types under comment mapping. The user can map comment types across connectors to decide the type of comments they want to integrate.
Parent ParameterNameRequiredTypeDescription
attachmentFalsePass this parameter if you want to integrate attachments for a given entity type. Otherwise, do not send the attachment parameter at all.
If this parameter is passed, SDK must implement all the Attachment APIs.
fieldNameInfoTrueObject

If the attachment parameter is sent back, then it is mandatory to send fieldNameInfo. The user needs to send field names as they will be sent by SDK to OpsHub when reading attachments and from OpsHub to SDK when adding or updating attachments. OpsHub will try to find the given information in the field name specified as part of the data sent here.

{
  "idFieldName": "id",
  "contentUriFieldName": "uri",
  "renderUriFieldName": "renderUri",
  "fileNameFieldName": "fileName",
  "contentTypeFieldName": "contentType",
  "contentLengthFieldName": "contentLength",
  "createdOrUpdatedDateFieldName": "updated",
  "createdByFieldName": "createdBy",
  "attachmentTypeFieldName": "attachmentType"
}


contentUriFieldName: The field which has the value as the URL to get/download the content of the attachment. If there's no such field in the end system, keep the fieldName as 'contentUri' and set the download link in that field in the actual attachment object.

renderUriFieldName: The field which has value as the URI to render/display the content of the attachment.

Note: This URI is not used to download an attachment. For downloading the attachment URI, refer to contentUriFieldName.

Example: If an inline image is shown with the <img> tag, render URI is the value of the src attribute of the <img> tag.

updateSupportedTrueBooleanSend true if the end system supports updating attachment via API; otherwise, false. If false, OpsHub will simulate update attachment behaviour by deleting the attachment and adding a new version.
deleteSupportedTrueBooleanSend true if the end system has an API to delete the attachment; otherwise, false.
historySupportedTrueBooleanDoes the system support history for attachment? True if yes, else false.
createUpdateDateFormatTrueStringDate format for created and updated dates of the attachment.
typesOfAttachmentsTrueList<String>Types of attachments supported by the system: INTERNAL, EXTERNAL, etc.
| Parent Parameter | Name | Required | Type | Description | | ---------------- | ------------------------- | -------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **inlineFile** | | False | |

Pass this parameter if you want to integrate inline files for a given entity type. Otherwise, do not send this parameter at all.
Attachment APIs must be implemented to integrate inline files.

| | | **deleteSupported** | True | Boolean | Does the system allow deleting inline files? | | | **inlineFileStorageType** | True | Enum |

Is the inline file/attachment stored at the entity or global level in the system?

Possible values:
1) ENTITY\_LEVEL\_STORAGE: When inline files are stored in the entity itself
2) EXTERNAL\_STORAGE: When inline files are stored at the system level

| | | **inlineFileUrlPrefix** | True | List\ |

What is the prefix of inline files?
This is used to identify if an inline file or image URL is the URL to some external site or the system's URL.

Provide the common initial part of the inline files URL. E.g., If the system has inline file URLs like these:
-
-
-

In this case, the inline file URL prefix is: ""

|
Parent ParameterNameRequiredTypeDescription
linkFalsePass this parameter if you want to integrate entity relationship for a given entity type. Otherwise, do not send this parameter at all. Links APIs must be implemented to integrate links
fieldNameInfoTrueObject
{
  "linkTypeFieldName": "linkType",
  "linkedEntityIdFieldName": "linkedEntityId",
  "linkedEntityTypeFieldName": "linkedEntityType",
  "linkedEntityScopeIdFieldName": "linkedEntityScopeId",
  "createdDateFieldName": "createdDate",
  "createdByFieldName": "createdBy",
  "linkCommentFieldName": "linkComment",
  "externalLinkUrlFieldName": "externalLinkUrl",
  "isExternalLinkFieldName": "isExternalLink"
}
deleteSupportedTrueBooleanDoes the system allow to delete link?
historySupportedTrueBooleanDoes the system support history for link?
createUpdateDateFormatTrueStringDate format for created and updated dates of link
linkTypesTrue
linkTypeTrueStringName of link type: Parent, Child, Relates To, Blocked By, etc
reverseLinkTypeTrueStringName of its reverse link. E.g., if the link type is Parent, then the opposite linkType is Child, i.e. Entity E1 is the parent of entity E2, and E2 is the child of E1
isMultiLinkAllowedTrueBooleanTrue: If multiple links of this type can be created. False: if only one link of this type can be created. For example: Adding only one parent is allowed to be added for any entity, so set multiLinkAllowed to false for Parent Type. On the other hand, for the ‘Related’ link type, any number of links can be added, so send true
isLinkMandatoryTrueBooleanTrue: If link of this type is mandatory for entity create or update. False: If link of this type is not mandatory for entity create or update. For example, it might be mandatory to have a Parent link to another work item for sub-task or task entity type. In this case, send true for the Parent link type for Task
isBulkLinkingSupportedTrueBooleanTrue: If bulk linking is supported via API. False: If bulk linking is not supported via API. For example, Bug and task can be linked by relates link type. Multiple tasks (with link type - relates) can be added and removed via a single API. In this case, send true for relates link type for Bug
Parent ParameterNameRequiredTypeDescription
link.rankrankFalse

If entity type supports keeping ordering / ranking of entities, provide metadata for that.
e.g., If entities can be ranked and the rank is preserved in the end system, it supports rank.

In below example, order of 1.1, 1.2, 1.3 are stored and can also be changed and preserved.
Similarly order of 2.1 and 2.2 is also preserved.

- 1
  - 1.1
  - 1.2
  - 1.3
- 2
  - 2.1
  - 2.2


The order can be stored in a field, e.g., rank.
The order can also be maintained through siblings (before and after).

Pass null if rank is not supported by entity type in the end system.

rankTypeTrueEnum

The way entities are ranked in the end system.

* FLAT_SINGLE: Entities of same type can only be ranked together.

Bug1
Bug2
Bug3


* FLAT_MULTIPLE: Entities of different types can be ranked together.

Bug1
Story1
Bug2
Story

* HIERARCHY_SINGLE: Entities of same type can be ranked in a tree structure.

Bug1
Bug2
  - Bug3
  - Bug4
Bug5


* HIERARCHY_MULTIPLE: Entities of different types can be ranked together in a tree structure.

Epic 1
Story 1
  - Bug 2
  - Story 2
  - Story 3
Epic 3
supportedRankOperationsTrueList<String>List of rank operations supported by the system for ranking entities.
* MOVE_BEFORE: Moves current entity before its sibling under a linked entity
* MOVE_AFTER: Moves current entity after its sibling under a linked entity
* LAST_IN_LIST: Move current entity at the end of the list under its linked entity.
* MOVE_BULK_AFTER: Reorders multiple child entities under a parent after a specific sibling.

Example:
Consider the below scenario, where entity type for entities Epic 1 and Epic 2 is Epic and entity type for entities Story 1, Story 2, Story 3, Story 4 and Story 5 is Story
Epic 1
- Story 1
- Story 2
- Story 3
- Story 4
- Story 5
Epic 2

MOVE_BEFORE: Story 3 is moved before Story 2.
Here, current entity is Story 3, siblingEntity is Story 2, and linked entity is Epic 1


MOVE_AFTER: Story 2 is moved after Story 4.
Here, current entity is Story 2, siblingEntity is Story 4, and linked entity is Epic 1

LAST_IN_LIST: Story 2 is moved at the last of the list under Epic 1.
Here, current entity is Story 2, and linked entity is Epic 1


MOVE_BULK_AFTER: The position of Story 3 and Story 5 are swapped. Now entities under Epic 1 are in following order - Story 1, Story 2, Story 5, Story 4, Story 3
Here, current entity is Epic 1, sibling entity is Story 2, and linked entities are Story 5, Story 4 and Story 3

Note:
* MOVE_BULK_AFTER should be provided for the entity under which links can be ordered in bulk manner. In the above example, MOVE_BULK_AFTER should be provided for entity type Epic.
* MOVE_BEFORE, MOVE_AFTER, and LAST_IN_LIST should be provided for the entity whose order is being changed. In the above example, these should be provided for entity type Story.
* If MOVE_BULK_AFTER is supported for an entity (e.g., Epic), it is not required to configure MOVE_BEFORE, MOVE_AFTER, or LAST_IN_LIST in the linked entity's (e.g., Story) metadata.
rankFieldNameFalseStringIf entity stores the rank information in a field, provide that field name. Example: stack rank in Azure DevOps, rank in Jira
rankScopeFalseObjectA scope in which the rank of an entity can be uniquely identified.

e.g., If the rank is uniquely identified under a project, the project id will be the scope of the rank.

If the rank is uniquely identified under a project and a module, the '{projectId} {moduleId}' will be the scope of the rank.

If the rank is always unique in the system (across projects, across modules, across components), the scope can be set as null.
Parent ParameterNameRequiredTypeDescription
link.rank.scope
templateTrueString

String template for rank scope.

What is the scope made of?

* If scope is just projectId, provide template as {0} and provide substitutes for projectId field name.
* If scope is projectId and entityType, provide template as {0}{1} and provide substitutes for projectId and entityTypeId field names.

e.g., "{0}", "{0}{1}", "{0}::{1}", etc.


If the projectId is 101 and entityType is 10001,

* If "{0}::{1}" is provided as template and substitutes are provided for projectId and entityTypeId, the actual scope will be "101::10001".

substitutesTrueObjectMap containing all the substitute numbers used in template and field name that needs to be replaced against given substitute.
The substitute field name can be any field in the entity object.

e.g.,
If a template is "{0}::{1}", substitute map can be as follows:
{"0": "projectIdFieldName", "1": "entityTypeIdFieldName"}

In the template:
* The value of parameter {0} will be replaced with actual value of project id for the entity.
* The value of parameter {1} will be replaced with actual value of entity type id for the entity.
| Parent Parameter | Name | Required | Type | Description | | ---------------- | --------------------- | -------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **userMention** | | False | | | | | userMentionDataType | True | Enum |

In the case of a given user mentioned, what data will SDK send for that user?
USERNAME\_AS\_USER: user's username
EMAIL\_AS\_USER: user's email address

Depending on the data type, OpsHub will search for required user information from the user API.

| | | **mentionDetails** | True | | | | | fieldDataType | True | Enum |

Type of usermention detection system for field or comment. Each type correlates with a data type of field or comment.
For e.g., HTML, WIKI, MARKDOWN, TEXT, HTML\_REGEX (If mention containing field is HTML type and all mentions are not detected with html selector, instead provide HTML\_REGEX enum and provide a regex in selectorOrRegex that can detect the mention).

| | | selectorOrRegex | True | List |

If the usermention detection system used is of type WIKI or TEXT, return regex to search usermention.
Example: return \\\[\~accountId:(\[a-z0-9.]+)\\] for searching \[\~accountId:john.doe] tags.

The regex should have 3 parts but only 1 group.
The regex must have only 1 group, corresponding to the user field's value as per userMentionDataType.

Prefix: \[\~accountId:
Infix: (\[a-z0-9.]+)
This part will be replaced with username or email
Only part for username/email should be provided as the group '()'
Postfix: ]

If the usermention detection system used is of type HTML, return HTML tag selector to search usermention.

Example:
If the usermention tag is \ tag having 'href' attribute, return a\[href] to search for usermention.
Return a\[href] for \ John Doe \ as the mention tag.

If HTML tag selector didn't work, use HTML\_REGEX as fieldDataType and return regex to search usermention.
Example: return "mentionUser\s(\w+)" for searching john\_doe and jane\_doe from data such as:
mentionUser john\_doe is working with mentionUser jane\_doe

It's important that regex has only 1 group and that 1 group captures the user data corresponding to the user field's value as per userMentionDataType.

| | | mentionTemplate | True | String |

Usermention template that will be used to create a usermention tag for the target system. As template variables, following variables can be used:

${id} : id of the user.
${username} : Username of the user.
${email} : Email of the user.
${displayName} : Display name of the user.

If null value is expected and default template variable value needs to be provided, ':-' operator can be used.

Examples:
${displayName:-Display Name}: This will replace this template variable with 'Display Name' if value of displayName is not present.
${displayName:-}: This will replace this template variable with '' (empty string) if value of displayName is not present.

As per various data types, mention templates can vary.

Examples:
HTML: \ ${displayName} \
Resolved: \ John Doe \

Wiki: \[\~accountId:${username}]
Resolved: \[\~accountId:john.doe]

Text: ${username} <${email}>
Resolved: john.doe <>

| | | userDataRegex | False | |

Regex to extract user data out of HTML tag attribute or inner text of tag.

This field is only needed when #fieldDataType is HTML and user data has to be extracted from HTML tag attribute or inner text.
This field can be null when #fieldDataType is not HTML.
It can also be null if one of the user field values is exact HTML attribute value or inner text.
This regex must have only 1 group which corresponds to the value of the user field as per #userMentionDataType.

Examples:
1. \](https://example.com/users?name=john.doe">) John Doe \
To extract the username from href, set userDataRegex to ".\*\[?&]name=(\[a-z.]+)".

2. \](https://example.com/users/101">) @john.doe \
To extract the username from inner text, set userDataRegex to "@(\[a-z.]+)".

3. \ John Doe \
Here, rel attribute's exact value is username. So, no need to provide regex. The userDataRegex can be null.

4. \](https://example.com/users/101">) john.doe \
Here, the inner text's exact value is username. So, no need to provide regex. Hence, the userDataRegex can be null.

| | | userDataAttributeName | False | String |

Name of the HTML tag attribute which contains user field value as per #userMentionDataType.
This field is only needed when #fieldDataType is HTML.
This field can be null when #fieldDataType is not HTML.
If for HTML data type, userDataAttributeName is null, HTML tag's inner text will be considered to have user field value.

| | Parent Parameter | Name | Required | Type | Description | | | | | | ----------------- | -------------------------- | -------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **entityMention** | | False | | | | | | | | | **mentionDetails** | True | | | | | | | | | **fieldDataType** | True | Enum |

Type of entity mention detection system for field or comment. Each type correlates with a data type of field or comment.

For example: HTML, WIKI, MARKDOWN, TEXT, HTML\_REGEX (If mention containing field is HTML type and all mentions are not detected with HTML selector, instead provide HTML\_REGEX enum and a regex in selectorOrRegex that can detect the mention).

| | | | | | | **selectorOrRegex** | True | List `` |

If the entity mention detection system used is of type WIKI or TEXT, return regex for which entity mention needs to be checked.

The regex must have only one group, corresponding to the entity mention’s value as per fieldDataType.
Example: \[\~(\[a-z0-9.]+)] would search for all \~entitymention tags.

If the detection system is HTML, return the selector for which entity mention needs to be checked.
Example: doc.select("a\[href]") will search for all anchor tags having an href attribute.

If the HTML tag selector didn’t work, use HTML\_REGEX as fieldDataType and return regex to search entity mention.
Example: return "workitem\s(\d+)" for searching entity with id 123 and 456 from data such as workitem 123 depends on workitem 456.

It's important that the regex has only one group, and that group captures the entity id of the mention.

| | | | | | | **mentionTemplate** | True | String |

The entityMention template that will be used to create an entity mention tag for the target system.

As template variables, the following variables can be used:
${entityId} – id of the entity
${entityDisplayId} – display id of the entity
${entityProject} – project name of the mention scope
${entityProjectId} – project id of the mention scope
${entityType} – entity type of the mention scope

As per various data types, mention templates can vary.

Examples:
HTML: \#${entityDisplayId}\
Resolved: \#Bug-101\

Wiki: | smart-link
Resolved: | smart-link

Text: ${entityId} <${entityDisplayId}>
Resolved: 101 \

| | | | | **entityIdAttribute** | True | |

Parameters to specify the entity id to be read from text, regex, or HTML attribute name.
For HTML tag element, attribute name is required.
For Wiki, regex is required.

| | | | | | | **dataAttributeName** | False | String |

This field is only required when fieldDataType is HTML. It can be null otherwise.
This field contains the name of the HTML tag attribute which contains the entity field value.
If fieldDataType is HTML and this field is null, the HTML tag’s inner text will be considered to have the entity field value.

| | | | | | | **dataRegEx** | False | String |

This field is used to extract entity information such as entity id, entity type, project id, or project name from the text.

In case of HTML, this extracts data from an HTML tag attribute or inner text, based on the selector in selectorOrRegex.
In case of WIKI, this extracts data from matched text using the selector provided.

This field is only required when fieldDataType is HTML and Id data has to be extracted from HTML tag attribute or inner text. It can be null otherwise or when the id value directly matches HTML content.

| | | | | | | **entityTypeAttribute** | False | |

If end system provide entity type corresponds to mentioned entity along with the mentioned entity id then it is recommended to provide the meta information to extract or read entity type information from mentioned tag.

If this parameter is not given then OpsHub will search mentioned entity using mentioned id parameter without the entity type and it would be considered that entity id is sufficient, otherwise OpsHub will search mentioned entity using entity type along with id. Examples:

Examples:
HTML: \Entity101\</a>](https://www.example.com/#/23468038167ud/defects?detail=/defect/669232438245">Entity101\</a>)
WIKI: \[DCPA3-7 | ] \[displayText | url]
For above entity mentioned tag the text 'defect' in html example and 'DEFECT' in wiki example is entity type.

WIKI: \[DCPA3-7 | ]\[displayText | url], For above tag: entity type does not exist as part of the mentioned tag, so end system do not require to provide this parameter entityTypeAttribute.

| | | **entityProjectAttribute** | False | |

If end system provide project corresponds to mentioned entity along with the mentioned entity id then it is recommended to provide the meta information to extract or read project information from mentioned tag.

If this parameter is not given then OpsHub will search mentioned entity using mentioned id parameter without the project and it would be considered that entity id is sufficient, otherwise OpsHub will search mentioned entity using project along with entity id.

Examples:
HTML: \#Bug-101\
WIKI: \[DCPA3-7 | ]\[displayText | url]
For above entity mentioned tag the text '40723eb0-0857-4970-a4f4-8cf657085847' in HTML example and 'TESTP' in WIKI example is project of mentioned entity.

WIKI: \[DCPA3-7 | ]\[displayText | url], For above tag: project does not exist as part of the mentioned tag, so end system do not require to provide this parameter entityProjectAttribute.

| | | **entityURLDetails** | False | |

This field supports reverse sync for source URL/target URL option.

Provide the matcher or selector for the matching entity URL of the end system.
If the system supports HTML mentions, provide a JSoup matcher for URLs within href.
If the system supports Wiki, provide a regex for URLs.
If both HTML and Wiki mentions are supported, provide a list of entity URL details in mention metadata.

| | | | | | | **entityWebURLMatcher** | False | String | This field contains regex or selector to match entity web url | | | | | | | **entityIdDataSelector** | False | String | This field contains regex to read the entity id from web url | | | | |