Script Controller

get
Authorizations
Path parameters
scriptIdstringRequired
Responses
200

OK

*/*
get
/api/scripts/{scriptId}
GET /api/scripts/{scriptId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "creationDate": "2025-10-30T23:32:53.100Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-10-30T23:32:53.100Z",
  "id": "text",
  "time": "2025-10-30T23:32:53.100Z",
  "dsc": "text",
  "name": "text",
  "projectId": "text",
  "period": 1,
  "log": true,
  "delay": 1,
  "offset": 1,
  "type": "Periodic",
  "code": "text",
  "owner": "text"
}
put
Authorizations
Path parameters
scriptIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
timestring · date-timeOptional
dscstring · max: 255Optional
namestring · max: 100Required
projectIdstringOptional
periodinteger · int32 · min: 100Optional
logbooleanRequired
delayinteger · int32Optional
offsetinteger · int32 · max: 59Optional
typestring · enumRequiredPossible values:
codestringRequired
ownerstringOptional
Responses
204

No Content

No content
put
/api/scripts/{scriptId}
PUT /api/scripts/{scriptId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 183

{
  "id": "text",
  "time": "2025-10-30T23:32:53.100Z",
  "dsc": "text",
  "name": "text",
  "projectId": "text",
  "period": 1,
  "log": true,
  "delay": 1,
  "offset": 1,
  "type": "Periodic",
  "code": "text",
  "owner": "text"
}
No content
delete
Authorizations
Path parameters
scriptIdstringRequired
Responses
204

No Content

No content
delete
/api/scripts/{scriptId}
DELETE /api/scripts/{scriptId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content
get
Authorizations
Responses
200

OK

*/*
get
/api/scripts
GET /api/scripts HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "creationDate": "2025-10-30T23:32:53.100Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-10-30T23:32:53.100Z",
    "id": "text",
    "time": "2025-10-30T23:32:53.100Z",
    "dsc": "text",
    "name": "text",
    "projectId": "text",
    "period": 1,
    "log": true,
    "delay": 1,
    "offset": 1,
    "type": "Periodic",
    "code": "text",
    "owner": "text"
  }
]
post
Authorizations
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
timestring · date-timeOptional
dscstring · max: 255Optional
namestring · max: 100Required
projectIdstringOptional
periodinteger · int32 · min: 100Optional
logbooleanRequired
delayinteger · int32Optional
offsetinteger · int32 · max: 59Optional
typestring · enumRequiredPossible values:
codestringRequired
ownerstringOptional
Responses
200

OK

*/*
post
/api/scripts
POST /api/scripts HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 183

{
  "id": "text",
  "time": "2025-10-30T23:32:53.100Z",
  "dsc": "text",
  "name": "text",
  "projectId": "text",
  "period": 1,
  "log": true,
  "delay": 1,
  "offset": 1,
  "type": "Periodic",
  "code": "text",
  "owner": "text"
}
{
  "creationDate": "2025-10-30T23:32:53.100Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-10-30T23:32:53.100Z",
  "id": "text",
  "time": "2025-10-30T23:32:53.100Z",
  "dsc": "text",
  "name": "text",
  "projectId": "text",
  "period": 1,
  "log": true,
  "delay": 1,
  "offset": 1,
  "type": "Periodic",
  "code": "text",
  "owner": "text"
}
post
Authorizations
Path parameters
scriptIdstringRequired
Responses
204

No Content

No content
post
/api/scripts/{scriptId}/schedule
POST /api/scripts/{scriptId}/schedule HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content
post
Authorizations
Path parameters
scriptIdstringRequired
Responses
200

OK

*/*
Responseobject
post
/api/scripts/{scriptId}/run
POST /api/scripts/{scriptId}/run HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{}
post
Authorizations
Path parameters
scriptIdstringRequired
Responses
204

No Content

No content
post
/api/scripts/{scriptId}/cancel
POST /api/scripts/{scriptId}/cancel HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content
post
Authorizations
Query parameters
projectIdstringRequired
Responses
204

No Content

No content
post
/api/scripts/schedule/by-project
POST /api/scripts/schedule/by-project?projectId=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content
post
Authorizations
Body
sessionIdstringOptional
projectIdstringOptional
compilebooleanOptional
namestringOptional
logbooleanOptional
codestringOptional
Responses
200

OK

*/*
Responseobject
post
/api/scripts/run
POST /api/scripts/run HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "sessionId": "text",
  "projectId": "text",
  "compile": true,
  "bindings": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "name": "text",
  "log": true,
  "code": "text"
}
{}
post
Authorizations
Query parameters
projectIdstringRequired
namestringRequired
Responses
200

OK

*/*
Responseobject
post
/api/scripts/run/by-project-and-name
POST /api/scripts/run/by-project-and-name?projectId=text&name=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{}
post
Authorizations
Query parameters
Body
filestring · binaryRequired
Responses
200

OK

*/*
Responseobject
post
/api/scripts/import
POST /api/scripts/import HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "file": "binary"
}
{}
post
Authorizations
Query parameters
projectIdstringRequired
Responses
204

No Content

No content
post
/api/scripts/cancel/by-project
POST /api/scripts/cancel/by-project?projectId=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content
post
Authorizations
Body
projectIdstringOptional
sessionIdstringOptional
argsobject[]Optional
methodstringOptional
Responses
200

OK

*/*
Responseobject
post
/api/scripts/call-api
POST /api/scripts/call-api HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "projectId": "text",
  "sessionId": "text",
  "args": [
    {}
  ],
  "method": "text"
}
{}
patch
Authorizations
Path parameters
scriptIdstringRequired
Body
stringOptional
Responses
204

No Content

No content
patch
/api/scripts/{scriptId}/code
PATCH /api/scripts/{scriptId}/code HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: text/plain
Accept: */*
Content-Length: 6

"text"
No content
get
Authorizations
Path parameters
scriptIdstringRequired
Responses
200

OK

*/*
Responsestring · enumPossible values:
get
/api/scripts/{scriptId}/status
GET /api/scripts/{scriptId}/status HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

Scheduled
get
Authorizations
Responses
200

OK

*/*
get
/api/scripts/summary
GET /api/scripts/summary HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "lastModifiedDate": "2025-10-30T23:32:53.100Z",
    "lastModifiedBy": "text",
    "id": "text",
    "dsc": "text",
    "creationDate": "2025-10-30T23:32:53.100Z",
    "log": true,
    "createdBy": "text",
    "name": "text",
    "type": "Periodic",
    "projectId": "text"
  }
]
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200

OK

*/*
get
/api/scripts/summary/by-project
GET /api/scripts/summary/by-project?projectId=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "lastModifiedDate": "2025-10-30T23:32:53.100Z",
    "lastModifiedBy": "text",
    "id": "text",
    "dsc": "text",
    "creationDate": "2025-10-30T23:32:53.100Z",
    "log": true,
    "createdBy": "text",
    "name": "text",
    "type": "Periodic",
    "projectId": "text"
  }
]
get
Authorizations
Query parameters
scriptIdsstring[]Required
Responses
200

OK

*/*
get
/api/scripts/status/by-ids
GET /api/scripts/status/by-ids?scriptIds=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "Scheduled"
}
get
Authorizations
Query parameters
projectIdstringOptional
includeIdsbooleanOptionalDefault: false
Responses
200

OK

*/*
Responseobject
get
/api/scripts/export
GET /api/scripts/export HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{}
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200

OK

*/*
get
/api/scripts/by-project
GET /api/scripts/by-project?projectId=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "creationDate": "2025-10-30T23:32:53.100Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-10-30T23:32:53.100Z",
    "id": "text",
    "time": "2025-10-30T23:32:53.100Z",
    "dsc": "text",
    "name": "text",
    "projectId": "text",
    "period": 1,
    "log": true,
    "delay": 1,
    "offset": 1,
    "type": "Periodic",
    "code": "text",
    "owner": "text"
  }
]
delete
Authorizations
Query parameters
scriptIdsstring[]Required
Responses
204

No Content

No content
delete
/api/scripts/multi/by-ids
DELETE /api/scripts/multi/by-ids?scriptIds=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content
PreviousSms Settings ControllerNextRole Controller

Last updated