# Symbol Controller

## GET /api/symbols/{symbolId}

>

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/symbols/{symbolId}":{"get":{"tags":["symbol-controller"],"operationId":"getSymbol","parameters":[{"name":"symbolId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"required":["content","name"],"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"},"dsc":{"type":"string"},"content":{"type":"string"},"name":{"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/symbols/{symbolId}

>

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/symbols/{symbolId}":{"put":{"tags":["symbol-controller"],"operationId":"updateSymbol","parameters":[{"name":"symbolId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["content","name"],"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"},"dsc":{"type":"string"},"content":{"type":"string"},"name":{"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/symbols/{symbolId}

>

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/symbols/{symbolId}":{"delete":{"tags":["symbol-controller"],"operationId":"deleteSymbol","parameters":[{"name":"symbolId","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/symbols

>

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/symbols":{"get":{"tags":["symbol-controller"],"operationId":"getSymbols","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"required":["content","name"],"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"},"dsc":{"type":"string"},"content":{"type":"string"},"name":{"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/symbols

>

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/symbols":{"post":{"tags":["symbol-controller"],"operationId":"createSymbol","requestBody":{"content":{"application/json":{"schema":{"required":["content","name"],"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"},"dsc":{"type":"string"},"content":{"type":"string"},"name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"required":["content","name"],"type":"object","properties":{"$ref":"#/paths/~1api~1symbols/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/symbols/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/symbols/import":{"post":{"tags":["symbol-controller"],"operationId":"importMetadataFromZip_4","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/symbols/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/symbols/export":{"get":{"tags":["symbol-controller"],"operationId":"exportMetadataToZip_4","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"}}}}}}}}}
```

## GET /api/symbols/by-name

>

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/symbols/by-name":{"get":{"tags":["symbol-controller"],"operationId":"getSymbolByName","parameters":[{"name":"symbolName","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"required":["content","name"],"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"},"dsc":{"type":"string"},"content":{"type":"string"},"name":{"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"}}}}}}}}}
```

## DELETE /api/symbols/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/symbols/multi/by-ids":{"delete":{"tags":["symbol-controller"],"operationId":"deleteSymbolsByIds","parameters":[{"name":"symbolIds","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"}}}}}}}}}
```
