Keyword Controller

get
Authorizations
Path parameters
keywordIdstringRequired
Responses
200
OK
*/*
get
GET /api/keywords/{keywordId} HTTP/1.1
Host: inscada.cloud
Accept: */*
{
  "creationDate": "2025-07-05T18:21:01.708Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T18:21:01.708Z",
  "id": "text",
  "key": "text",
  "dsc": "text",
  "type": "Logs Activity",
  "active": true,
  "props": "text"
}
put
Authorizations
Path parameters
keywordIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
keystring · max: 100Required
dscstring · max: 255Optional
typestring · enumRequiredPossible values:
activebooleanOptional
propsstringOptional
Responses
204
No Content
put
PUT /api/keywords/{keywordId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "id": "text",
  "key": "text",
  "dsc": "text",
  "type": "Logs Activity",
  "active": true,
  "props": "text"
}

No content

delete
Authorizations
Path parameters
keywordIdstringRequired
Responses
204
No Content
delete
DELETE /api/keywords/{keywordId} HTTP/1.1
Host: inscada.cloud
Accept: */*

No content

get
Authorizations
Responses
200
OK
*/*
get
GET /api/keywords HTTP/1.1
Host: inscada.cloud
Accept: */*
[
  {
    "creationDate": "2025-07-05T18:21:01.708Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T18:21:01.708Z",
    "id": "text",
    "key": "text",
    "dsc": "text",
    "type": "Logs Activity",
    "active": true,
    "props": "text"
  }
]
post
Authorizations
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
keystring · max: 100Required
dscstring · max: 255Optional
typestring · enumRequiredPossible values:
activebooleanOptional
propsstringOptional
Responses
200
OK
*/*
post
POST /api/keywords HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "id": "text",
  "key": "text",
  "dsc": "text",
  "type": "Logs Activity",
  "active": true,
  "props": "text"
}
{
  "creationDate": "2025-07-05T18:21:01.708Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T18:21:01.708Z",
  "id": "text",
  "key": "text",
  "dsc": "text",
  "type": "Logs Activity",
  "active": true,
  "props": "text"
}
post
Authorizations
Query parameters
Body
filestring · binaryRequired
Responses
200
OK
*/*
Responseobject
post
POST /api/keywords/import HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "file": "binary"
}
{}
get
Authorizations
Query parameters
typestringRequired
Responses
200
OK
*/*
get
GET /api/keywords/type HTTP/1.1
Host: inscada.cloud
Accept: */*
[
  {
    "creationDate": "2025-07-05T18:21:01.708Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T18:21:01.708Z",
    "id": "text",
    "key": "text",
    "dsc": "text",
    "type": "Logs Activity",
    "active": true,
    "props": "text"
  }
]
get
Authorizations
Query parameters
projectIdstringOptional
includeIdsbooleanOptionalDefault: false
Responses
200
OK
*/*
Responseobject
get
GET /api/keywords/export HTTP/1.1
Host: inscada.cloud
Accept: */*
{}
delete
Authorizations
Query parameters
keywordIdsstring[]Required
Responses
204
No Content
delete
DELETE /api/keywords/multi/by-ids HTTP/1.1
Host: inscada.cloud
Accept: */*

No content