Animation Controller

get
Authorizations
Path parameters
animationIdstringRequired
Responses
200
OK
*/*
get
GET /api/animations/{animationId} HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-07-05T19:40:59.797Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T19:40:59.797Z",
  "id": "text",
  "mainFlag": true,
  "color": "text",
  "dsc": "text",
  "postAnimCode": "text",
  "playOrder": 1,
  "preAnimCode": "text",
  "duration": 1,
  "placeholders": "text",
  "projectId": "text",
  "name": "text",
  "alignment": "text",
  "animationScripts": [
    {
      "creationDate": "2025-07-05T19:40:59.797Z",
      "lastModifiedBy": "text",
      "createdBy": "text",
      "lastModifiedDate": "2025-07-05T19:40:59.797Z",
      "id": "text",
      "type": "pre",
      "scriptId": "text",
      "animationId": "text"
    }
  ],
  "svgContent": "text",
  "configs": "text",
  "animJoinId": "text"
}
put
Authorizations
Path parameters
animationIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
mainFlagbooleanRequired
colorstring · max: 7Optional
dscstring · max: 255Optional
postAnimCodestringOptional
playOrderinteger · int32 · min: 1Required
preAnimCodestringOptional
durationinteger · int32 · min: 100Required
placeholdersstringOptional
projectIdstringOptional
namestring · max: 100Required
alignmentstringOptional
svgContentstringRequired
configsstringOptional
animJoinIdstringOptional
Responses
204
No Content
put
PUT /api/animations/{animationId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 345

{
  "id": "text",
  "mainFlag": true,
  "color": "text",
  "dsc": "text",
  "postAnimCode": "text",
  "playOrder": 1,
  "preAnimCode": "text",
  "duration": 1,
  "placeholders": "text",
  "projectId": "text",
  "name": "text",
  "alignment": "text",
  "animationScripts": [
    {
      "id": "text",
      "type": "pre",
      "scriptId": "text",
      "animationId": "text"
    }
  ],
  "svgContent": "text",
  "configs": "text",
  "animJoinId": "text"
}
No content
delete
Authorizations
Path parameters
animationIdstringRequired
Responses
204
No Content
delete
DELETE /api/animations/{animationId} HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
get
Authorizations
Path parameters
animationIdstringRequired
Responses
200
OK
*/*
Responsestring · binary
get
GET /api/animations/{animationId}/svg HTTP/1.1
Host: inscada.cloud
Accept: */*

binary
put
Authorizations
Path parameters
animationIdstringRequired
Body
stringOptional
Responses
204
No Content
put
PUT /api/animations/{animationId}/svg HTTP/1.1
Host: inscada.cloud
Content-Type: text/plain
Accept: */*
Content-Length: 6

"text"
No content
get
Authorizations
Path parameters
animationIdstringRequired
scriptIdstringRequired
Responses
200
OK
*/*
get
GET /api/animations/{animationId}/scripts/{scriptId} HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-07-05T19:40:59.797Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T19:40:59.797Z",
  "id": "text",
  "type": "pre",
  "scriptId": "text",
  "animationId": "text"
}
put
Authorizations
Path parameters
animationIdstringRequired
scriptIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
typestring · enumRequiredPossible values:
scriptIdstringOptional
animationIdstringOptional
Responses
204
No Content
put
PUT /api/animations/{animationId}/scripts/{scriptId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "id": "text",
  "type": "pre",
  "scriptId": "text",
  "animationId": "text"
}
No content
delete
Authorizations
Path parameters
animationIdstringRequired
scriptIdstringRequired
Responses
204
No Content
delete
DELETE /api/animations/{animationId}/scripts/{scriptId} HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
put
Authorizations
Path parameters
animationIdstringRequired
Body
stringOptional
Responses
204
No Content
put
PUT /api/animations/{animationId}/placeholders HTTP/1.1
Host: inscada.cloud
Content-Type: text/plain
Accept: */*
Content-Length: 6

"text"
No content
get
Authorizations
Path parameters
animationIdstringRequired
elementIdstringRequired
Responses
200
OK
*/*
get
GET /api/animations/{animationId}/elements/{elementId} HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-07-05T19:40:59.797Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T19:40:59.797Z",
  "id": "text",
  "dsc": "text",
  "name": "text",
  "animationId": "text",
  "expressionType": "EXPRESSION",
  "props": "text",
  "status": true,
  "expression": "text",
  "type": "Bar",
  "domId": "text"
}
put
Authorizations
Path parameters
animationIdstringRequired
elementIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
dscstring · max: 255Optional
namestring · max: 255Optional
animationIdstringOptional
expressionTypestring · enumRequiredPossible values:
propsstringRequired
statusbooleanRequired
expressionstringRequired
typestring · enumRequiredPossible values:
domIdstring · max: 100Required
Responses
204
No Content
put
PUT /api/animations/{animationId}/elements/{elementId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 168

{
  "id": "text",
  "dsc": "text",
  "name": "text",
  "animationId": "text",
  "expressionType": "EXPRESSION",
  "props": "text",
  "status": true,
  "expression": "text",
  "type": "Bar",
  "domId": "text"
}
No content
delete
Authorizations
Path parameters
animationIdstringRequired
elementIdstringRequired
Responses
204
No Content
delete
DELETE /api/animations/{animationId}/elements/{elementId} HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
get
Authorizations
Responses
200
OK
*/*
get
GET /api/animations HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-05T19:40:59.797Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T19:40:59.797Z",
    "id": "text",
    "mainFlag": true,
    "color": "text",
    "dsc": "text",
    "postAnimCode": "text",
    "playOrder": 1,
    "preAnimCode": "text",
    "duration": 1,
    "placeholders": "text",
    "projectId": "text",
    "name": "text",
    "alignment": "text",
    "animationScripts": [
      {
        "creationDate": "2025-07-05T19:40:59.797Z",
        "lastModifiedBy": "text",
        "createdBy": "text",
        "lastModifiedDate": "2025-07-05T19:40:59.797Z",
        "id": "text",
        "type": "pre",
        "scriptId": "text",
        "animationId": "text"
      }
    ],
    "svgContent": "text",
    "configs": "text",
    "animJoinId": "text"
  }
]
post
Authorizations
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
mainFlagbooleanRequired
colorstring · max: 7Optional
dscstring · max: 255Optional
postAnimCodestringOptional
playOrderinteger · int32 · min: 1Required
preAnimCodestringOptional
durationinteger · int32 · min: 100Required
placeholdersstringOptional
projectIdstringOptional
namestring · max: 100Required
alignmentstringOptional
svgContentstringRequired
configsstringOptional
animJoinIdstringOptional
Responses
200
OK
*/*
post
POST /api/animations HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 345

{
  "id": "text",
  "mainFlag": true,
  "color": "text",
  "dsc": "text",
  "postAnimCode": "text",
  "playOrder": 1,
  "preAnimCode": "text",
  "duration": 1,
  "placeholders": "text",
  "projectId": "text",
  "name": "text",
  "alignment": "text",
  "animationScripts": [
    {
      "id": "text",
      "type": "pre",
      "scriptId": "text",
      "animationId": "text"
    }
  ],
  "svgContent": "text",
  "configs": "text",
  "animJoinId": "text"
}
{
  "creationDate": "2025-07-05T19:40:59.797Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T19:40:59.797Z",
  "id": "text",
  "mainFlag": true,
  "color": "text",
  "dsc": "text",
  "postAnimCode": "text",
  "playOrder": 1,
  "preAnimCode": "text",
  "duration": 1,
  "placeholders": "text",
  "projectId": "text",
  "name": "text",
  "alignment": "text",
  "animationScripts": [
    {
      "creationDate": "2025-07-05T19:40:59.797Z",
      "lastModifiedBy": "text",
      "createdBy": "text",
      "lastModifiedDate": "2025-07-05T19:40:59.797Z",
      "id": "text",
      "type": "pre",
      "scriptId": "text",
      "animationId": "text"
    }
  ],
  "svgContent": "text",
  "configs": "text",
  "animJoinId": "text"
}
get
Authorizations
Path parameters
animationIdstringRequired
Responses
200
OK
*/*
get
GET /api/animations/{animationId}/scripts HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-05T19:40:59.797Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T19:40:59.797Z",
    "id": "text",
    "type": "pre",
    "scriptId": "text",
    "animationId": "text"
  }
]
post
Authorizations
Path parameters
animationIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
typestring · enumRequiredPossible values:
scriptIdstringOptional
animationIdstringOptional
Responses
200
OK
*/*
post
POST /api/animations/{animationId}/scripts HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "id": "text",
  "type": "pre",
  "scriptId": "text",
  "animationId": "text"
}
{
  "creationDate": "2025-07-05T19:40:59.797Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T19:40:59.797Z",
  "id": "text",
  "type": "pre",
  "scriptId": "text",
  "animationId": "text"
}
get
Authorizations
Path parameters
animationIdstringRequired
Responses
200
OK
*/*
get
GET /api/animations/{animationId}/elements HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-05T19:40:59.797Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T19:40:59.797Z",
    "id": "text",
    "dsc": "text",
    "name": "text",
    "animationId": "text",
    "expressionType": "EXPRESSION",
    "props": "text",
    "status": true,
    "expression": "text",
    "type": "Bar",
    "domId": "text"
  }
]
post
Authorizations
Path parameters
animationIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
dscstring · max: 255Optional
namestring · max: 255Optional
animationIdstringOptional
expressionTypestring · enumRequiredPossible values:
propsstringRequired
statusbooleanRequired
expressionstringRequired
typestring · enumRequiredPossible values:
domIdstring · max: 100Required
Responses
200
OK
*/*
post
POST /api/animations/{animationId}/elements HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 168

{
  "id": "text",
  "dsc": "text",
  "name": "text",
  "animationId": "text",
  "expressionType": "EXPRESSION",
  "props": "text",
  "status": true,
  "expression": "text",
  "type": "Bar",
  "domId": "text"
}
{
  "creationDate": "2025-07-05T19:40:59.797Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T19:40:59.797Z",
  "id": "text",
  "dsc": "text",
  "name": "text",
  "animationId": "text",
  "expressionType": "EXPRESSION",
  "props": "text",
  "status": true,
  "expression": "text",
  "type": "Bar",
  "domId": "text"
}
delete
Authorizations
Path parameters
animationIdstringRequired
Query parameters
elementIdsstring[]Required
Responses
204
No Content
delete
DELETE /api/animations/{animationId}/elements HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
post
Authorizations
Path parameters
animationIdstringRequired
Query parameters
namestringRequired
Responses
200
OK
*/*
post
POST /api/animations/{animationId}/clone HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-07-05T19:40:59.797Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T19:40:59.797Z",
  "id": "text",
  "mainFlag": true,
  "color": "text",
  "dsc": "text",
  "postAnimCode": "text",
  "playOrder": 1,
  "preAnimCode": "text",
  "duration": 1,
  "placeholders": "text",
  "projectId": "text",
  "name": "text",
  "alignment": "text",
  "animationScripts": [
    {
      "creationDate": "2025-07-05T19:40:59.797Z",
      "lastModifiedBy": "text",
      "createdBy": "text",
      "lastModifiedDate": "2025-07-05T19:40:59.797Z",
      "id": "text",
      "type": "pre",
      "scriptId": "text",
      "animationId": "text"
    }
  ],
  "svgContent": "text",
  "configs": "text",
  "animJoinId": "text"
}
post
Authorizations
Body
parametersstringOptional
langstringOptional
animationIdstringOptional
sendIdstringOptional
animNamestringOptional
Responses
200
OK
post
POST /api/animations/run-animation-script HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 235

{
  "parameters": "text",
  "lang": "text",
  "animationId": "text",
  "sendId": "text",
  "animName": "text",
  "script": {
    "sessionId": "text",
    "projectId": "text",
    "compile": true,
    "bindings": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "name": "text",
    "log": true,
    "code": "text"
  }
}
No content
post
Authorizations
Query parameters
Body
filestring · binaryRequired
Responses
200
OK
*/*
Responseobject
post
POST /api/animations/import HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "file": "binary"
}
{}
post
Authorizations
Body
sessionIdstringOptional
animNamestringOptional
sendIdstringOptional
langstringOptional
parametersstringOptional
firstScanbooleanOptional
animationIdstringOptional
callbackIdstringOptional
Responses
200
OK
post
POST /api/animations/eval-animation HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 146

{
  "sessionId": "text",
  "animName": "text",
  "sendId": "text",
  "lang": "text",
  "parameters": "text",
  "firstScan": true,
  "animationId": "text",
  "callbackId": "text"
}
No content
get
Authorizations
Path parameters
animationIdstringRequired
Query parameters
typestring · enumRequiredPossible values:
Responses
200
OK
*/*
get
GET /api/animations/{animationId}/elements/by-type HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-05T19:40:59.797Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T19:40:59.797Z",
    "id": "text",
    "dsc": "text",
    "name": "text",
    "animationId": "text",
    "expressionType": "EXPRESSION",
    "props": "text",
    "status": true,
    "expression": "text",
    "type": "Bar",
    "domId": "text"
  }
]
get
Authorizations
Query parameters
projectIdstringOptional
includeIdsbooleanOptionalDefault: false
Responses
200
OK
*/*
Responseobject
get
GET /api/animations/export HTTP/1.1
Host: inscada.cloud
Accept: */*

{}
get
Authorizations
Query parameters
namestringRequired
typestring · enumRequiredPossible values:
Responses
200
OK
*/*
get
GET /api/animations/elements/by-name-and-type HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-07-05T19:40:59.797Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T19:40:59.797Z",
  "id": "text",
  "dsc": "text",
  "name": "text",
  "animationId": "text",
  "expressionType": "EXPRESSION",
  "props": "text",
  "status": true,
  "expression": "text",
  "type": "Bar",
  "domId": "text"
}
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200
OK
*/*
get
GET /api/animations/by-project HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-05T19:40:59.797Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T19:40:59.797Z",
    "id": "text",
    "mainFlag": true,
    "color": "text",
    "dsc": "text",
    "postAnimCode": "text",
    "playOrder": 1,
    "preAnimCode": "text",
    "duration": 1,
    "placeholders": "text",
    "projectId": "text",
    "name": "text",
    "alignment": "text",
    "animationScripts": [
      {
        "creationDate": "2025-07-05T19:40:59.797Z",
        "lastModifiedBy": "text",
        "createdBy": "text",
        "lastModifiedDate": "2025-07-05T19:40:59.797Z",
        "id": "text",
        "type": "pre",
        "scriptId": "text",
        "animationId": "text"
      }
    ],
    "svgContent": "text",
    "configs": "text",
    "animJoinId": "text"
  }
]
get
Authorizations
Query parameters
projectNamestringRequired
namestringRequired
Responses
200
OK
*/*
get
GET /api/animations/by-project-name-and-name HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-07-05T19:40:59.797Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T19:40:59.797Z",
  "id": "text",
  "mainFlag": true,
  "color": "text",
  "dsc": "text",
  "postAnimCode": "text",
  "playOrder": 1,
  "preAnimCode": "text",
  "duration": 1,
  "placeholders": "text",
  "projectId": "text",
  "name": "text",
  "alignment": "text",
  "animationScripts": [
    {
      "creationDate": "2025-07-05T19:40:59.797Z",
      "lastModifiedBy": "text",
      "createdBy": "text",
      "lastModifiedDate": "2025-07-05T19:40:59.797Z",
      "id": "text",
      "type": "pre",
      "scriptId": "text",
      "animationId": "text"
    }
  ],
  "svgContent": "text",
  "configs": "text",
  "animJoinId": "text"
}
get
Authorizations
Query parameters
projectIdstringRequired
namesstring[]Required
Responses
200
OK
*/*
get
GET /api/animations/by-project-id-and-names HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-05T19:40:59.797Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T19:40:59.797Z",
    "id": "text",
    "mainFlag": true,
    "color": "text",
    "dsc": "text",
    "postAnimCode": "text",
    "playOrder": 1,
    "preAnimCode": "text",
    "duration": 1,
    "placeholders": "text",
    "projectId": "text",
    "name": "text",
    "alignment": "text",
    "animationScripts": [
      {
        "creationDate": "2025-07-05T19:40:59.797Z",
        "lastModifiedBy": "text",
        "createdBy": "text",
        "lastModifiedDate": "2025-07-05T19:40:59.797Z",
        "id": "text",
        "type": "pre",
        "scriptId": "text",
        "animationId": "text"
      }
    ],
    "svgContent": "text",
    "configs": "text",
    "animJoinId": "text"
  }
]
get
Authorizations
Query parameters
projectIdstringRequired
namestringRequired
Responses
200
OK
*/*
get
GET /api/animations/by-project-id-and-name HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-07-05T19:40:59.797Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T19:40:59.797Z",
  "id": "text",
  "mainFlag": true,
  "color": "text",
  "dsc": "text",
  "postAnimCode": "text",
  "playOrder": 1,
  "preAnimCode": "text",
  "duration": 1,
  "placeholders": "text",
  "projectId": "text",
  "name": "text",
  "alignment": "text",
  "animationScripts": [
    {
      "creationDate": "2025-07-05T19:40:59.797Z",
      "lastModifiedBy": "text",
      "createdBy": "text",
      "lastModifiedDate": "2025-07-05T19:40:59.797Z",
      "id": "text",
      "type": "pre",
      "scriptId": "text",
      "animationId": "text"
    }
  ],
  "svgContent": "text",
  "configs": "text",
  "animJoinId": "text"
}
PreviousBroadcast Settings ControllerNextAnalog Alarm Controller