# Keyword Controller

## GET /api/keywords/{keywordId}

>

OpenAPI:

```json
{"openapi":"3.0.1","info":{"title":"inSCADA API","version":"20250703-6"},"servers":[{"url":"https://inscada.cloud","description":"Generated server url"}],"security":[{"accessTokenCookie":[],"spaceHeader":[]}],"components":{"securitySchemes":{"accessTokenCookie":{"type":"apiKey","description":"Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the `ins_refresh_token` cookie at the /refresh endpoint.","name":"ins_access_token","in":"cookie"}}},"paths":{"/api/keywords/{keywordId}":{"get":{"tags":["keyword-controller"],"operationId":"getKeyword","parameters":[{"name":"keywordId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"required":["key","type"],"type":"object","properties":{"creationDate":{"type":"string","format":"date-time","readOnly":true},"lastModifiedBy":{"type":"string","readOnly":true},"createdBy":{"type":"string","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","readOnly":true},"id":{"type":"string"},"key":{"maxLength":100,"minLength":0,"type":"string"},"dsc":{"maxLength":255,"minLength":0,"type":"string"},"type":{"type":"string","enum":["Logs Activity","Trends","Reports"]},"active":{"type":"boolean"},"props":{"type":"string"}}}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"type":"object"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"object"}}}},"409":{"description":"Conflict","content":{"*/*":{"schema":{"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"object"}}}}}}}}}
```

## PUT /api/keywords/{keywordId}

>

OpenAPI:

```json
{"openapi":"3.0.1","info":{"title":"inSCADA API","version":"20250703-6"},"servers":[{"url":"https://inscada.cloud","description":"Generated server url"}],"security":[{"accessTokenCookie":[],"spaceHeader":[]}],"components":{"securitySchemes":{"accessTokenCookie":{"type":"apiKey","description":"Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the `ins_refresh_token` cookie at the /refresh endpoint.","name":"ins_access_token","in":"cookie"}}},"paths":{"/api/keywords/{keywordId}":{"put":{"tags":["keyword-controller"],"operationId":"updateKeyword","parameters":[{"name":"keywordId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["key","type"],"type":"object","properties":{"creationDate":{"type":"string","format":"date-time","readOnly":true},"lastModifiedBy":{"type":"string","readOnly":true},"createdBy":{"type":"string","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","readOnly":true},"id":{"type":"string"},"key":{"maxLength":100,"minLength":0,"type":"string"},"dsc":{"maxLength":255,"minLength":0,"type":"string"},"type":{"type":"string","enum":["Logs Activity","Trends","Reports"]},"active":{"type":"boolean"},"props":{"type":"string"}}}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"type":"object"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"object"}}}},"409":{"description":"Conflict","content":{"*/*":{"schema":{"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"object"}}}}}}}}}
```

## DELETE /api/keywords/{keywordId}

>

OpenAPI:

```json
{"openapi":"3.0.1","info":{"title":"inSCADA API","version":"20250703-6"},"servers":[{"url":"https://inscada.cloud","description":"Generated server url"}],"security":[{"accessTokenCookie":[],"spaceHeader":[]}],"components":{"securitySchemes":{"accessTokenCookie":{"type":"apiKey","description":"Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the `ins_refresh_token` cookie at the /refresh endpoint.","name":"ins_access_token","in":"cookie"}}},"paths":{"/api/keywords/{keywordId}":{"delete":{"tags":["keyword-controller"],"operationId":"deleteKeyword","parameters":[{"name":"keywordId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"type":"object"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"object"}}}},"409":{"description":"Conflict","content":{"*/*":{"schema":{"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"object"}}}}}}}}}
```

## GET /api/keywords

>

OpenAPI:

```json
{"openapi":"3.0.1","info":{"title":"inSCADA API","version":"20250703-6"},"servers":[{"url":"https://inscada.cloud","description":"Generated server url"}],"security":[{"accessTokenCookie":[],"spaceHeader":[]}],"components":{"securitySchemes":{"accessTokenCookie":{"type":"apiKey","description":"Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the `ins_refresh_token` cookie at the /refresh endpoint.","name":"ins_access_token","in":"cookie"}}},"paths":{"/api/keywords":{"get":{"tags":["keyword-controller"],"operationId":"getKeywords","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"required":["key","type"],"type":"object","properties":{"creationDate":{"type":"string","format":"date-time","readOnly":true},"lastModifiedBy":{"type":"string","readOnly":true},"createdBy":{"type":"string","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","readOnly":true},"id":{"type":"string"},"key":{"maxLength":100,"minLength":0,"type":"string"},"dsc":{"maxLength":255,"minLength":0,"type":"string"},"type":{"type":"string","enum":["Logs Activity","Trends","Reports"]},"active":{"type":"boolean"},"props":{"type":"string"}}}}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"type":"object"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"object"}}}},"409":{"description":"Conflict","content":{"*/*":{"schema":{"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"object"}}}}}}}}}
```

## POST /api/keywords

>

OpenAPI:

```json
{"openapi":"3.0.1","info":{"title":"inSCADA API","version":"20250703-6"},"servers":[{"url":"https://inscada.cloud","description":"Generated server url"}],"security":[{"accessTokenCookie":[],"spaceHeader":[]}],"components":{"securitySchemes":{"accessTokenCookie":{"type":"apiKey","description":"Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the `ins_refresh_token` cookie at the /refresh endpoint.","name":"ins_access_token","in":"cookie"}}},"paths":{"/api/keywords":{"post":{"tags":["keyword-controller"],"operationId":"createKeyword","requestBody":{"content":{"application/json":{"schema":{"required":["key","type"],"type":"object","properties":{"creationDate":{"type":"string","format":"date-time","readOnly":true},"lastModifiedBy":{"type":"string","readOnly":true},"createdBy":{"type":"string","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","readOnly":true},"id":{"type":"string"},"key":{"maxLength":100,"minLength":0,"type":"string"},"dsc":{"maxLength":255,"minLength":0,"type":"string"},"type":{"type":"string","enum":["Logs Activity","Trends","Reports"]},"active":{"type":"boolean"},"props":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"required":["key","type"],"type":"object","properties":{"$ref":"#/paths/~1api~1keywords/post/requestBody/content/application~1json/schema/properties"}}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"type":"object"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"object"}}}},"409":{"description":"Conflict","content":{"*/*":{"schema":{"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"object"}}}}}}}}}
```

## POST /api/keywords/import

>

OpenAPI:

```json
{"openapi":"3.0.1","info":{"title":"inSCADA API","version":"20250703-6"},"servers":[{"url":"https://inscada.cloud","description":"Generated server url"}],"security":[{"accessTokenCookie":[],"spaceHeader":[]}],"components":{"securitySchemes":{"accessTokenCookie":{"type":"apiKey","description":"Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the `ins_refresh_token` cookie at the /refresh endpoint.","name":"ins_access_token","in":"cookie"}}},"paths":{"/api/keywords/import":{"post":{"tags":["keyword-controller"],"operationId":"importMetadataFromZip_12","parameters":[{"name":"importChecks","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Project","AlarmGroup","Alarm","Animation","Connection","Device","Variable","Script","Report","Trend","Expression","DataTransfer","Template","Role","Keyword","VariableMonitor","Language","TraceTable","Dashboard","JsPdfReport","Faceplate","CustomSqlQuery","CustomInfluxDBQuery","JasperReport","CustomSqlDatasource","CustomInfluxDBDatasource","CustomMenu","Symbol","File"]}}}],"requestBody":{"content":{"application/json":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"type":"object"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"object"}}}},"409":{"description":"Conflict","content":{"*/*":{"schema":{"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"object"}}}}}}}}}
```

## GET /api/keywords/type

>

OpenAPI:

```json
{"openapi":"3.0.1","info":{"title":"inSCADA API","version":"20250703-6"},"servers":[{"url":"https://inscada.cloud","description":"Generated server url"}],"security":[{"accessTokenCookie":[],"spaceHeader":[]}],"components":{"securitySchemes":{"accessTokenCookie":{"type":"apiKey","description":"Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the `ins_refresh_token` cookie at the /refresh endpoint.","name":"ins_access_token","in":"cookie"}}},"paths":{"/api/keywords/type":{"get":{"tags":["keyword-controller"],"operationId":"getKeywordsByType","parameters":[{"name":"type","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"required":["key","type"],"type":"object","properties":{"creationDate":{"type":"string","format":"date-time","readOnly":true},"lastModifiedBy":{"type":"string","readOnly":true},"createdBy":{"type":"string","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","readOnly":true},"id":{"type":"string"},"key":{"maxLength":100,"minLength":0,"type":"string"},"dsc":{"maxLength":255,"minLength":0,"type":"string"},"type":{"type":"string","enum":["Logs Activity","Trends","Reports"]},"active":{"type":"boolean"},"props":{"type":"string"}}}}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"type":"object"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"object"}}}},"409":{"description":"Conflict","content":{"*/*":{"schema":{"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"object"}}}}}}}}}
```

## GET /api/keywords/export

>

OpenAPI:

```json
{"openapi":"3.0.1","info":{"title":"inSCADA API","version":"20250703-6"},"servers":[{"url":"https://inscada.cloud","description":"Generated server url"}],"security":[{"accessTokenCookie":[],"spaceHeader":[]}],"components":{"securitySchemes":{"accessTokenCookie":{"type":"apiKey","description":"Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the `ins_refresh_token` cookie at the /refresh endpoint.","name":"ins_access_token","in":"cookie"}}},"paths":{"/api/keywords/export":{"get":{"tags":["keyword-controller"],"operationId":"exportMetadataToZip_12","parameters":[{"name":"exportChecks","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Project","AlarmGroup","Alarm","Animation","Connection","Device","Variable","Script","Report","Trend","Expression","DataTransfer","Template","Role","Keyword","VariableMonitor","Language","TraceTable","Dashboard","JsPdfReport","Faceplate","CustomSqlQuery","CustomInfluxDBQuery","JasperReport","CustomSqlDatasource","CustomInfluxDBDatasource","CustomMenu","Symbol","File"]}}},{"name":"projectId","in":"query","required":false,"schema":{"type":"string"}},{"name":"includeIds","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"type":"object"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"object"}}}},"409":{"description":"Conflict","content":{"*/*":{"schema":{"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"object"}}}}}}}}}
```

## DELETE /api/keywords/multi/by-ids

>

OpenAPI:

```json
{"openapi":"3.0.1","info":{"title":"inSCADA API","version":"20250703-6"},"servers":[{"url":"https://inscada.cloud","description":"Generated server url"}],"security":[{"accessTokenCookie":[],"spaceHeader":[]}],"components":{"securitySchemes":{"accessTokenCookie":{"type":"apiKey","description":"Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the `ins_refresh_token` cookie at the /refresh endpoint.","name":"ins_access_token","in":"cookie"}}},"paths":{"/api/keywords/multi/by-ids":{"delete":{"tags":["keyword-controller"],"operationId":"deleteKeywordsByIds","parameters":[{"name":"keywordIds","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"type":"object"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"object"}}}},"409":{"description":"Conflict","content":{"*/*":{"schema":{"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"object"}}}}}}}}}
```
