Project Controller
get
Authorizations
Path parameters
projectIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/projects/{projectId} HTTP/1.1
Host: inscada.cloud
Accept: */*
{
"creationDate": "2025-07-05T18:59:52.018Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T18:59:52.018Z",
"id": "text",
"properties": "text",
"latitude": 1,
"longitude": 1,
"isActive": true,
"address": "text",
"contractHour": "text",
"dsc": "text",
"name": "text",
"icon": "text",
"contractDay": 1
}
put
Authorizations
Path parameters
projectIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
propertiesstringOptional
latitudenumber · doubleOptional
longitudenumber · doubleOptional
isActivebooleanRequired
addressstring · max: 255Optional
contractHourstringOptional
dscstring · max: 255Optional
namestring · max: 100Required
iconstringOptional
contractDayinteger · int32Optional
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
put
PUT /api/projects/{projectId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 172
{
"id": "text",
"properties": "text",
"latitude": 1,
"longitude": 1,
"isActive": true,
"address": "text",
"contractHour": "text",
"dsc": "text",
"name": "text",
"icon": "text",
"contractDay": 1
}
No content
delete
Authorizations
Path parameters
projectIdstringRequired
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
delete
DELETE /api/projects/{projectId} HTTP/1.1
Host: inscada.cloud
Accept: */*
No content
get
Authorizations
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/projects HTTP/1.1
Host: inscada.cloud
Accept: */*
[
{
"creationDate": "2025-07-05T18:59:52.018Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T18:59:52.018Z",
"id": "text",
"properties": "text",
"latitude": 1,
"longitude": 1,
"isActive": true,
"address": "text",
"contractHour": "text",
"dsc": "text",
"name": "text",
"icon": "text",
"contractDay": 1
}
]
post
Authorizations
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
propertiesstringOptional
latitudenumber · doubleOptional
longitudenumber · doubleOptional
isActivebooleanRequired
addressstring · max: 255Optional
contractHourstringOptional
dscstring · max: 255Optional
namestring · max: 100Required
iconstringOptional
contractDayinteger · int32Optional
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
post
POST /api/projects HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 172
{
"id": "text",
"properties": "text",
"latitude": 1,
"longitude": 1,
"isActive": true,
"address": "text",
"contractHour": "text",
"dsc": "text",
"name": "text",
"icon": "text",
"contractDay": 1
}
{
"creationDate": "2025-07-05T18:59:52.018Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T18:59:52.018Z",
"id": "text",
"properties": "text",
"latitude": 1,
"longitude": 1,
"isActive": true,
"address": "text",
"contractHour": "text",
"dsc": "text",
"name": "text",
"icon": "text",
"contractDay": 1
}
post
Authorizations
Query parameters
Body
filestring · binaryRequired
Responses
200
OK
*/*
Responseobject
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
post
POST /api/projects/import HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 17
{
"file": "binary"
}
{}
post
Authorizations
Body
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
post
POST /api/projects/clone HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 289
{
"connections": [
{
"id": "text",
"protocol": "Modbus TCP",
"port": 1,
"name": "text",
"ip": "text",
"timeoutInMs": 1
}
],
"project": {
"id": "text",
"properties": "text",
"latitude": 1,
"longitude": 1,
"isActive": true,
"address": "text",
"contractHour": "text",
"dsc": "text",
"name": "text",
"icon": "text",
"contractDay": 1
}
}
{
"errors": [
"text"
],
"successCount": 1,
"failCount": 1
}
patch
Authorizations
Path parameters
projectIdstringRequired
Body
longitudenumber · doubleOptional
latitudenumber · doubleOptional
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
patch
PATCH /api/projects/{projectId}/location HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 28
{
"longitude": 1,
"latitude": 1
}
No content
get
Authorizations
Path parameters
projectIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/projects/{projectId}/status HTTP/1.1
Host: inscada.cloud
Accept: */*
{
"alarmGroupStatuses": {
"ANY_ADDITIONAL_PROPERTY": "Active"
},
"scriptStatuses": {
"ANY_ADDITIONAL_PROPERTY": "Scheduled"
},
"dataTransferStatuses": {
"ANY_ADDITIONAL_PROPERTY": "Scheduled"
},
"connectionStatuses": {
"ANY_ADDITIONAL_PROPERTY": "Connected"
},
"reportStatuses": {
"ANY_ADDITIONAL_PROPERTY": "Scheduled"
}
}
get
Authorizations
Query parameters
projectIdstringOptional
includeIdsbooleanOptionalDefault:
false
Responses
200
OK
*/*
Responseobject
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/projects/export HTTP/1.1
Host: inscada.cloud
Accept: */*
{}
get
Authorizations
Query parameters
namestringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/projects/by-name HTTP/1.1
Host: inscada.cloud
Accept: */*
{
"creationDate": "2025-07-05T18:59:52.018Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T18:59:52.018Z",
"id": "text",
"properties": "text",
"latitude": 1,
"longitude": 1,
"isActive": true,
"address": "text",
"contractHour": "text",
"dsc": "text",
"name": "text",
"icon": "text",
"contractDay": 1
}
get
Authorizations
Query parameters
isActivebooleanRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/projects/by-active HTTP/1.1
Host: inscada.cloud
Accept: */*
[
{
"creationDate": "2025-07-05T18:59:52.018Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T18:59:52.018Z",
"id": "text",
"properties": "text",
"latitude": 1,
"longitude": 1,
"isActive": true,
"address": "text",
"contractHour": "text",
"dsc": "text",
"name": "text",
"icon": "text",
"contractDay": 1
}
]