# Entity Tags
URL: https://docs.datarobot.com/en/docs/api/reference/public-api/entity_tags.html

> Use the endpoints described below to configure tags for your entities (e.g., use cases).

# Entity Tags

Use the endpoints described below to configure tags for your entities (e.g., use cases).

## Retrieve the list of entity tags

Operation path: `GET /api/v2/entityTags/`

Authentication requirements: `BearerAuth`

Retrieve the list of entity tags.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| offset | query | integer | false | The number of records to skip over. Default 0. |
| limit | query | integer | false | The number of records to return in the range from 1 to 100. Default 100. |
| search | query | string | false | Returns only Entity Tags with names that match the given string. |
| entityType | query | string | false | Returns only Entity Tags with entityType that match the given type. |
| orderBy | query | string | true | The order in which to return entity tags. |

### Enumerated Values

| Parameter | Value |
| --- | --- |
| entityType | experiment_container |
| orderBy | [-entityType, -id, -name, entityType, id, name] |

### Example responses

> 200 Response

```
{
  "properties": {
    "count": {
      "description": "The number of items returned on this page.",
      "type": "integer"
    },
    "data": {
      "description": "The list of entity tags that match the query.",
      "items": {
        "properties": {
          "entityType": {
            "description": "The type of entity provided.",
            "enum": [
              "experiment_container"
            ],
            "type": "string"
          },
          "id": {
            "description": "The ID of the entity tag.",
            "type": "string"
          },
          "name": {
            "description": "The name of the entity tag.",
            "type": "string"
          }
        },
        "required": [
          "entityType",
          "id",
          "name"
        ],
        "type": "object",
        "x-versionadded": "v2.36"
      },
      "maxItems": 100,
      "type": "array"
    },
    "next": {
      "description": "The URL of the next page (if null, there is no next page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "previous": {
      "description": "The URL of the previous page (if null, there is no previous page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "totalCount": {
      "description": "The total number of items across all pages.",
      "type": "integer"
    }
  },
  "required": [
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object",
  "x-versionadded": "v2.36"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | Entity tags retrieved successfully. | EntityTagListResponse |
| 403 | Forbidden | User does not have access to this functionality. | None |

## Get entity tag

Operation path: `POST /api/v2/entityTags/`

Authentication requirements: `BearerAuth`

Look up an entity tag.

### Body parameter

```
{
  "properties": {
    "entityType": {
      "description": "The type of entity provided.",
      "enum": [
        "experiment_container"
      ],
      "type": "string"
    },
    "name": {
      "description": "The name of the Tag.",
      "maxLength": 100,
      "type": "string"
    }
  },
  "required": [
    "entityType",
    "name"
  ],
  "type": "object",
  "x-versionadded": "v2.36"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| body | body | EntityTagCreate | false | none |

### Example responses

> 200 Response

```
{
  "properties": {
    "entityType": {
      "description": "The type of entity provided.",
      "enum": [
        "experiment_container"
      ],
      "type": "string"
    },
    "id": {
      "description": "The ID of the entity tag.",
      "type": "string"
    },
    "name": {
      "description": "The name of the entity tag.",
      "type": "string"
    }
  },
  "required": [
    "entityType",
    "id",
    "name"
  ],
  "type": "object",
  "x-versionadded": "v2.36"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | The entity tag. | EntityTagResponse |
| 201 | Created | The tag was successfully created. | None |
| 422 | Unprocessable Entity | Unprocessable Entity | None |

## Delete an entity tag by entity tag ID

Operation path: `DELETE /api/v2/entityTags/{entityTagId}/`

Authentication requirements: `BearerAuth`

Delete an entity tag.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| entityTagId | path | string | true | The ID of the entity tag. |

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 204 | No Content | none | None |

## Update entity tag by entity tag ID

Operation path: `PATCH /api/v2/entityTags/{entityTagId}/`

Authentication requirements: `BearerAuth`

Update an entity tag.

### Body parameter

```
{
  "properties": {
    "name": {
      "description": "The name of the entity tag.",
      "maxLength": 100,
      "type": [
        "string",
        "null"
      ]
    }
  },
  "type": "object",
  "x-versionadded": "v2.36"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| entityTagId | path | string | true | The ID of the entity tag. |
| body | body | EntityTagUpdate | false | none |

### Example responses

> 204 Response

```
{
  "properties": {
    "entityType": {
      "description": "The type of entity provided.",
      "enum": [
        "experiment_container"
      ],
      "type": "string"
    },
    "id": {
      "description": "The ID of the entity tag.",
      "type": "string"
    },
    "name": {
      "description": "The name of the entity tag.",
      "type": "string"
    }
  },
  "required": [
    "entityType",
    "id",
    "name"
  ],
  "type": "object",
  "x-versionadded": "v2.36"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 204 | No Content | The entity tag has been successfully updated. | EntityTagResponse |
| 403 | Forbidden | User does not have access to this functionality. | None |
| 404 | Not Found | Tag not found. | None |
| 422 | Unprocessable Entity | Unprocessable Entity | None |

# Schemas

## EntityTagCreate

```
{
  "properties": {
    "entityType": {
      "description": "The type of entity provided.",
      "enum": [
        "experiment_container"
      ],
      "type": "string"
    },
    "name": {
      "description": "The name of the Tag.",
      "maxLength": 100,
      "type": "string"
    }
  },
  "required": [
    "entityType",
    "name"
  ],
  "type": "object",
  "x-versionadded": "v2.36"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| entityType | string | true |  | The type of entity provided. |
| name | string | true | maxLength: 100 | The name of the Tag. |

### Enumerated Values

| Property | Value |
| --- | --- |
| entityType | experiment_container |

## EntityTagListResponse

```
{
  "properties": {
    "count": {
      "description": "The number of items returned on this page.",
      "type": "integer"
    },
    "data": {
      "description": "The list of entity tags that match the query.",
      "items": {
        "properties": {
          "entityType": {
            "description": "The type of entity provided.",
            "enum": [
              "experiment_container"
            ],
            "type": "string"
          },
          "id": {
            "description": "The ID of the entity tag.",
            "type": "string"
          },
          "name": {
            "description": "The name of the entity tag.",
            "type": "string"
          }
        },
        "required": [
          "entityType",
          "id",
          "name"
        ],
        "type": "object",
        "x-versionadded": "v2.36"
      },
      "maxItems": 100,
      "type": "array"
    },
    "next": {
      "description": "The URL of the next page (if null, there is no next page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "previous": {
      "description": "The URL of the previous page (if null, there is no previous page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "totalCount": {
      "description": "The total number of items across all pages.",
      "type": "integer"
    }
  },
  "required": [
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object",
  "x-versionadded": "v2.36"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| count | integer | false |  | The number of items returned on this page. |
| data | [EntityTagResponse] | true | maxItems: 100 | The list of entity tags that match the query. |
| next | string,null(uri) | true |  | The URL of the next page (if null, there is no next page). |
| previous | string,null(uri) | true |  | The URL of the previous page (if null, there is no previous page). |
| totalCount | integer | true |  | The total number of items across all pages. |

## EntityTagResponse

```
{
  "properties": {
    "entityType": {
      "description": "The type of entity provided.",
      "enum": [
        "experiment_container"
      ],
      "type": "string"
    },
    "id": {
      "description": "The ID of the entity tag.",
      "type": "string"
    },
    "name": {
      "description": "The name of the entity tag.",
      "type": "string"
    }
  },
  "required": [
    "entityType",
    "id",
    "name"
  ],
  "type": "object",
  "x-versionadded": "v2.36"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| entityType | string | true |  | The type of entity provided. |
| id | string | true |  | The ID of the entity tag. |
| name | string | true |  | The name of the entity tag. |

### Enumerated Values

| Property | Value |
| --- | --- |
| entityType | experiment_container |

## EntityTagUpdate

```
{
  "properties": {
    "name": {
      "description": "The name of the entity tag.",
      "maxLength": 100,
      "type": [
        "string",
        "null"
      ]
    }
  },
  "type": "object",
  "x-versionadded": "v2.36"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| name | string,null | false | maxLength: 100 | The name of the entity tag. |

---
