Skript Modul

Manage scripting modules in VARIO Cloud, including scripts, domains, parameters, permissions, presettings, creation, updates, and deletion.

Skript-Modul

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

Skript-Modul

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

domainstring · enumRequired

Verwendungsbereiche für die Skriptmodule

Possible values:

namestring · max: 255Required

Name

Pattern: [a-zA-Z0-9_-]*

descriptionstringOptional

Beschreibung

appIdentifierstring · uuidOptional

Identifier der App

scriptstring · min: 1Required

Skript

sameAsPresettingScriptbooleanRead-onlyOptional

Entspricht das Skript dem Presetting-Skript?

Default: false

withPresettingScriptbooleanRead-onlyOptional

Gibt es ein Presetting-Skript?

Default: false

404

Resource with given ID was not found

application/json

get/cmn/scripting/modules/{id}

GET /cmn/scripting/modules/{id} HTTP/1.1
Host: api.example.com
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "domain": "UNDEFINED",
  "name": "text",
  "description": "text",
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "script": "text",
  "sameAsPresettingScript": false,
  "withPresettingScript": false,
  "groupRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "parameters": [],
  "permissionAggregation": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "userPermissions": [],
    "groupPermissions": [],
    "operationForAllUsers": "READ_ONLY"
  }
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

Skript-Modul

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

domainstring · enumRequired

Verwendungsbereiche für die Skriptmodule

Possible values:

namestring · max: 255Required

Name

Pattern: [a-zA-Z0-9_-]*

descriptionstringOptional

Beschreibung

appIdentifierstring · uuidOptional

Identifier der App

scriptstring · min: 1Required

Skript

sameAsPresettingScriptbooleanRead-onlyOptional

Entspricht das Skript dem Presetting-Skript?

Default: false

withPresettingScriptbooleanRead-onlyOptional

Gibt es ein Presetting-Skript?

Default: false

Responses

200

successful operation

application/json

Skript-Modul

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

domainstring · enumRequired

Verwendungsbereiche für die Skriptmodule

Possible values:

namestring · max: 255Required

Name

Pattern: [a-zA-Z0-9_-]*

descriptionstringOptional

Beschreibung

appIdentifierstring · uuidOptional

Identifier der App

scriptstring · min: 1Required

Skript

sameAsPresettingScriptbooleanRead-onlyOptional

Entspricht das Skript dem Presetting-Skript?

Default: false

withPresettingScriptbooleanRead-onlyOptional

Gibt es ein Presetting-Skript?

Default: false

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put/cmn/scripting/modules/{id}

PUT /cmn/scripting/modules/{id} HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 351

{
  "version": "text",
  "info": {},
  "id": "text",
  "domain": "UNDEFINED",
  "name": "text",
  "description": "text",
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "script": "text",
  "groupRef": {
    "id": "text"
  },
  "parameters": [],
  "permissionAggregation": {
    "version": "text",
    "info": {},
    "id": "text",
    "userPermissions": [],
    "groupPermissions": [],
    "operationForAllUsers": "READ_ONLY"
  }
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "domain": "UNDEFINED",
  "name": "text",
  "description": "text",
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "script": "text",
  "sameAsPresettingScript": false,
  "withPresettingScript": false,
  "groupRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "parameters": [],
  "permissionAggregation": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "userPermissions": [],
    "groupPermissions": [],
    "operationForAllUsers": "READ_ONLY"
  }
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

contextstringOptional

message context

messageValuestringOptional

message

404

Resource was not found

application/json

409

unable to delete Resource, due to constraints, existing references or internal state

application/json

delete/cmn/scripting/modules/{id}

DELETE /cmn/scripting/modules/{id} HTTP/1.1
Host: api.example.com
Accept: */*

{
  "context": "text",
  "messageValue": "text"
}

get

Path parameters

idinteger · int64Required

ID eines Skript-Moduls

Responses

200

OK

application/json

Skript-Modul

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

domainstring · enumRequired

Verwendungsbereiche für die Skriptmodule

Possible values:

namestring · max: 255Required

Name

Pattern: [a-zA-Z0-9_-]*

descriptionstringOptional

Beschreibung

appIdentifierstring · uuidOptional

Identifier der App

scriptstring · min: 1Required

Skript

sameAsPresettingScriptbooleanRead-onlyOptional

Entspricht das Skript dem Presetting-Skript?

Default: false

withPresettingScriptbooleanRead-onlyOptional

Gibt es ein Presetting-Skript?

Default: false

get/cmn/scripting/modules/{id}/presettings

GET /cmn/scripting/modules/{id}/presettings HTTP/1.1
Host: api.example.com
Accept: */*

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "domain": "UNDEFINED",
  "name": "text",
  "description": "text",
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "script": "text",
  "sameAsPresettingScript": false,
  "withPresettingScript": false,
  "groupRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "parameters": [],
  "permissionAggregation": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "userPermissions": [],
    "groupPermissions": [],
    "operationForAllUsers": "READ_ONLY"
  }
}

put

Path parameters

idinteger · int64Required

ID eines Skript-Moduls

Body

Skript-Modul

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

domainstring · enumRequired

Verwendungsbereiche für die Skriptmodule

Possible values:

namestring · max: 255Required

Name

Pattern: [a-zA-Z0-9_-]*

descriptionstringOptional

Beschreibung

appIdentifierstring · uuidOptional

Identifier der App

scriptstring · min: 1Required

Skript

sameAsPresettingScriptbooleanRead-onlyOptional

Entspricht das Skript dem Presetting-Skript?

Default: false

withPresettingScriptbooleanRead-onlyOptional

Gibt es ein Presetting-Skript?

Default: false

Responses

200

OK

application/json

Skript-Modul

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

domainstring · enumRequired

Verwendungsbereiche für die Skriptmodule

Possible values:

namestring · max: 255Required

Name

Pattern: [a-zA-Z0-9_-]*

descriptionstringOptional

Beschreibung

appIdentifierstring · uuidOptional

Identifier der App

scriptstring · min: 1Required

Skript

sameAsPresettingScriptbooleanRead-onlyOptional

Entspricht das Skript dem Presetting-Skript?

Default: false

withPresettingScriptbooleanRead-onlyOptional

Gibt es ein Presetting-Skript?

Default: false

put/cmn/scripting/modules/{id}/presettings

PUT /cmn/scripting/modules/{id}/presettings HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 351

{
  "version": "text",
  "info": {},
  "id": "text",
  "domain": "UNDEFINED",
  "name": "text",
  "description": "text",
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "script": "text",
  "groupRef": {
    "id": "text"
  },
  "parameters": [],
  "permissionAggregation": {
    "version": "text",
    "info": {},
    "id": "text",
    "userPermissions": [],
    "groupPermissions": [],
    "operationForAllUsers": "READ_ONLY"
  }
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "domain": "UNDEFINED",
  "name": "text",
  "description": "text",
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "script": "text",
  "sameAsPresettingScript": false,
  "withPresettingScript": false,
  "groupRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "parameters": [],
  "permissionAggregation": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "userPermissions": [],
    "groupPermissions": [],
    "operationForAllUsers": "READ_ONLY"
  }
}

put

Path parameters

idinteger · int64Required

ID eines Skript-Moduls

Responses

200

OK

application/json

Skript-Modul

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

domainstring · enumRequired

Verwendungsbereiche für die Skriptmodule

Possible values:

namestring · max: 255Required

Name

Pattern: [a-zA-Z0-9_-]*

descriptionstringOptional

Beschreibung

appIdentifierstring · uuidOptional

Identifier der App

scriptstring · min: 1Required

Skript

sameAsPresettingScriptbooleanRead-onlyOptional

Entspricht das Skript dem Presetting-Skript?

Default: false

withPresettingScriptbooleanRead-onlyOptional

Gibt es ein Presetting-Skript?

Default: false

put/cmn/scripting/modules/{id}/presettings/reset

PUT /cmn/scripting/modules/{id}/presettings/reset HTTP/1.1
Host: api.example.com
Accept: */*

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "domain": "UNDEFINED",
  "name": "text",
  "description": "text",
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "script": "text",
  "sameAsPresettingScript": false,
  "withPresettingScript": false,
  "groupRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "parameters": [],
  "permissionAggregation": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "userPermissions": [],
    "groupPermissions": [],
    "operationForAllUsers": "READ_ONLY"
  }
}

Create new Resource

post

Body

Skript-Modul

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

domainstring · enumRequired

Verwendungsbereiche für die Skriptmodule

Possible values:

namestring · max: 255Required

Name

Pattern: [a-zA-Z0-9_-]*

descriptionstringOptional

Beschreibung

appIdentifierstring · uuidOptional

Identifier der App

scriptstring · min: 1Required

Skript

sameAsPresettingScriptbooleanRead-onlyOptional

Entspricht das Skript dem Presetting-Skript?

Default: false

withPresettingScriptbooleanRead-onlyOptional

Gibt es ein Presetting-Skript?

Default: false

Responses

200

successful operation

application/json

Skript-Modul

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

domainstring · enumRequired

Verwendungsbereiche für die Skriptmodule

Possible values:

namestring · max: 255Required

Name

Pattern: [a-zA-Z0-9_-]*

descriptionstringOptional

Beschreibung

appIdentifierstring · uuidOptional

Identifier der App

scriptstring · min: 1Required

Skript

sameAsPresettingScriptbooleanRead-onlyOptional

Entspricht das Skript dem Presetting-Skript?

Default: false

withPresettingScriptbooleanRead-onlyOptional

Gibt es ein Presetting-Skript?

Default: false

422

Resource was not valid to process

application/json

post/cmn/scripting/modules

POST /cmn/scripting/modules HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 351

{
  "version": "text",
  "info": {},
  "id": "text",
  "domain": "UNDEFINED",
  "name": "text",
  "description": "text",
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "script": "text",
  "groupRef": {
    "id": "text"
  },
  "parameters": [],
  "permissionAggregation": {
    "version": "text",
    "info": {},
    "id": "text",
    "userPermissions": [],
    "groupPermissions": [],
    "operationForAllUsers": "READ_ONLY"
  }
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "domain": "UNDEFINED",
  "name": "text",
  "description": "text",
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "script": "text",
  "sameAsPresettingScript": false,
  "withPresettingScript": false,
  "groupRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "parameters": [],
  "permissionAggregation": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "userPermissions": [],
    "groupPermissions": [],
    "operationForAllUsers": "READ_ONLY"
  }
}

post

Body

Skript-Modul

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

domainstring · enumRequired

Verwendungsbereiche für die Skriptmodule

Possible values:

namestring · max: 255Required

Name

Pattern: [a-zA-Z0-9_-]*

descriptionstringOptional

Beschreibung

appIdentifierstring · uuidOptional

Identifier der App

scriptstring · min: 1Required

Skript

sameAsPresettingScriptbooleanRead-onlyOptional

Entspricht das Skript dem Presetting-Skript?

Default: false

withPresettingScriptbooleanRead-onlyOptional

Gibt es ein Presetting-Skript?

Default: false

Responses

200

OK

application/json

Skript-Modul

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

domainstring · enumRequired

Verwendungsbereiche für die Skriptmodule

Possible values:

namestring · max: 255Required

Name

Pattern: [a-zA-Z0-9_-]*

descriptionstringOptional

Beschreibung

appIdentifierstring · uuidOptional

Identifier der App

scriptstring · min: 1Required

Skript

sameAsPresettingScriptbooleanRead-onlyOptional

Entspricht das Skript dem Presetting-Skript?

Default: false

withPresettingScriptbooleanRead-onlyOptional

Gibt es ein Presetting-Skript?

Default: false

post/cmn/scripting/modules/presettings

POST /cmn/scripting/modules/presettings HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 351

{
  "version": "text",
  "info": {},
  "id": "text",
  "domain": "UNDEFINED",
  "name": "text",
  "description": "text",
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "script": "text",
  "groupRef": {
    "id": "text"
  },
  "parameters": [],
  "permissionAggregation": {
    "version": "text",
    "info": {},
    "id": "text",
    "userPermissions": [],
    "groupPermissions": [],
    "operationForAllUsers": "READ_ONLY"
  }
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "domain": "UNDEFINED",
  "name": "text",
  "description": "text",
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "script": "text",
  "sameAsPresettingScript": false,
  "withPresettingScript": false,
  "groupRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "parameters": [],
  "permissionAggregation": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "userPermissions": [],
    "groupPermissions": [],
    "operationForAllUsers": "READ_ONLY"
  }
}