Create an Entity

This operation creates a new entity

Request Body

Name	Description
entityName	Desired name of the entity
regularExpression	Desired regular expresssion of entity
parentEntityId	Id value of desired parent entity
flags	Sensitivity value of entity values: 1 - moderate 3 - high 5 - critical
enabled	boolean value to represent enable value of entity values: true - enable entity false - disable entity
keywords	String of desired keywords, separated by commas

Header Parameters

• Accept string required

application/json

Request Body

• entityName string
• regularExpression string
• parentEntityId integer
• flags integer
• enabled boolean
• entityXML object

  keywords string

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• entityDetails object[]

  regularExpression string

  displayName string

  flags integer

  parentEntityId integer

  categoryName string

  enabled boolean

  entityName string

  entityType integer

  entityKey string

  entityId integer

  entityXML object

  keywords string

{
  "entityDetails": [
    {
      "regularExpression": "string",
      "displayName": "string",
      "flags": 0,
      "parentEntityId": 0,
      "categoryName": "string",
      "enabled": true,
      "entityName": "string",
      "entityType": 0,
      "entityKey": "string",
      "entityId": 0,
      "entityXML": {
        "keywords": "string"
      }
    }
  ]
}

{
  "entityDetails": [
    {
      "regularExpression": "{\"entity_regex\":\"Sample Regular Expression\"}",
      "displayName": "RestApiEntity",
      "flags": 1,
      "parentEntityId": 0,
      "categoryName": "Custom Entity",
      "enabled": true,
      "entityName": "RestApiEntity",
      "entityType": 2,
      "entityKey": "restapientity",
      "entityId": 110,
      "entityXML": {
        "keywords": "Sample Keyword, Sample Keyword 2"
      }
    }
  ]
}

Loading...