Entity Types List

API URI

This is the URI, OpsHub will execute to call this API:

GET: /entity-types?projectId=<projectId>

URI Parameters

Name	In	Required	Type	Description
projectId	Query	True	String	Project id for which list of entity types available need to be returned. ProjectId here will be same as ‘id’ sent as part of /projects

Response Payload

[ 

  { 

    "id": "unique identifier for each entity type", 

    "name": "Entity type name that will be visible to user on OpsHub UI", 

          "direction": "SOURCE_ONLY, TARGET_ONLY, BOTH" 

    "pollerType": "CURRENT_STATE, NON_TIME_BASED, ENTITY_WISE_HISTORY" ,

    "isSoftDeleteSupported": "true / false" ,

    "belongsToCategories": "List of Categories in which given Entity Type belongs to" ,

    "projectMovementSupported": "Indicates if movement of the Entity type across projects is supported through API.",

    "isArchiveSupported": "true / false"

  } 

] 

Entity Type Response Parameters

Name	Required	Type	Description
id	True	String	Internal name of the entity. If end system does not have different internal name for an entity type, pass display name here too.
name	True	String	Display name of the entity.
direction	True	Enum	In which direction can we sync the data in end system? - SOURCE_ONLY: End system is read only - TARGET_ONLY: End system is write only - BOTH: End system allows both read and write
pollerType	True	Enum	Types of poller: - CURRENT_STATE: Current state will be synced. Set this pollerType if it is possible from API to query entities based on their create and update time. - NON_TIME_BASED: Current state will be synced. Set this pollerType if it is not possible from API to query entities based on their create and update time. - ENTITY_WISE_HISTORY: Complete entity history will be integrated. Set this pollerType if the end system has APIs to query history (audits) of entities.
isSoftDeleteSupported	False	Boolean	Set to true if end system supports soft delete for the given entity type; else, set it to false.
isArchiveSupported	False	Boolean	Set to true if the end system supports archive operation for the given entity type; else, set it to false.
belongsToCategories	False	List	List of categories in which the given entity type belongs. Each category indicates interconvertibility between entity types. For instance, if both "Bug" and "Story" are assigned to the "WorkItems" category, it indicates that these two entity types can be converted mutually. A bug can be transformed into a story, and a story can likewise be converted into a bug. There is flexibility to define any category names necessary for sets of entity types that are convertible to each other, with no limit on the number of categories. Category names are case-insensitive (e.g., "workitems" and "WorkItems" are treated as the same). Each category name can have a maximum of 50 characters and can only consists of uppercase letters [A-Z], lowercase letters [a-z], digits [0-9], and underscores [_]. However, spaces are not permitted. Behavior when belongsToCategories is either null, empty, or has no other entity types in the same category: If the belongsToCategories list is either null or empty, or if a given category has no other associated entity types (for example, if "category1" only has one entity type), and entity type movement is detected, the following actions will take place: the old entity type will be marked as deprecated, and a new entity with the updated entity type will be created in the end system. Note: To assign the belongsToCategories list, all categories that an Entity Type may belong to must be specified from the defined categories. Example: Project1: bug, feature,task,story Project2: requirement, task, testplan Both conversion of project and Entity type is detected like: Old: project1, bug New: project2, requirement Since the entity type 'bug' of project1 can be converted to entity type 'requirement' of project2, both these entity types must have at least one category in common.
projectMovementSupported	False	Boolean	Indicates if the movement of the entity type across projects is supported through API. If the given entity type can be moved to any project across instance through API, then this should be true.In other case, this should be false. By default, it will be treated as false. Behavior when projectMovementSupported is false: If the projectMovementSupported is false with a given category, and project movement is detected, the following will occur: the old entity present in the old project will be marked as deprecated, and a new entity in the new project will be created in the end system.

Examples

1) When Entity Type or Project Movement is not supported

[
  {
    "id": "100",
    "name": "Requirement",
    "direction": "BOTH",
    "pollerType": "CURRENT_STATE",
    "isSoftDeleteSupported": "true",
    "isArchiveSupported": "true"
  },
  {
    "id": "BUG",
    "name": "Defect",
    "direction": "BOTH",
    "pollerType": "ENTITY_WISE_HISTORY",
    "isSoftDeleteSupported": "false",
    "isArchiveSupported": "true"
  },
  {
    "id": "200",
    "name": "Feature",
    "direction": "SOURCE_ONLY",
    "pollerType": "CURRENT_STATE",
    "isSoftDeleteSupported": "true",
    "isArchiveSupported": "true"
  }
]

2) When Entity Type or Project Movement is supported

In the below example, for Entity Type and project movement scenario is like:

Requirement: Can be converted to Bug and Feature. Can be moved to another project.

Bug: Can be converted to Requirement only. Cannot be moved to another project.

Feature: Can be converted to Requirement only. Can be moved to another project.

Test Run: Cannot be converted to any other Entity Type. Can be moved to another project.

Story: Cannot be converted to any other Entity Type. Cannot be moved to another project.

In this scenario, since there is no Category in common between Bug and Feature, they cannot be converted to each other.

[
  {
    "id": "100",
    "name": "Requirement",
    "direction": "BOTH",
    "pollerType": "CURRENT_STATE",
    "isSoftDeleteSupported": "true",
    "isArchiveSupported": "false",
    "belongsToCategories": ["WorkItemsC1","WorkItemsC2"],
    "projectMovementSupported": "true"
  },
  {
    "id": "BUG",
    "name": "Defect",
    "direction": "BOTH",
    "pollerType": "ENTITY_WISE_HISTORY",
    "isSoftDeleteSupported": "false",
    "isArchiveSupported": "true",
    "belongsToCategories": ["WorkItemsC1"],
    "projectMovementSupported": "false"
  },
  {
    "id": "200",
    "name": "Feature",
    "direction": "SOURCE_ONLY",
    "pollerType": "CURRENT_STATE",
    "isSoftDeleteSupported": "true",
    "isArchiveSupported": "false",
    "belongsToCategories": ["WorkItemsC2"],
    "projectMovementSupported": "true"
  },
  {
    "id": "Test Run",
    "name": "Test Run",
    "direction": "WRITE_ONLY",
    "pollerType": "CURRENT_STATE",
    "isSoftDeleteSupported": "true",
    "isArchiveSupported": "false",
    "belongsToCategories": [],
    "projectMovementSupported": "true"
  },
  {
    "id": "Story",
    "name": "Story",
    "direction": "BOTH",
    "pollerType": "CURRENT_STATE",
    "isSoftDeleteSupported": "true",
    "isArchiveSupported": "false",
    "belongsToCategories": null
  }
]