Notification Scripts

List

Retrieves a list of notification script information

GET/api/NotificationScripts

Query parameters

SiteIdinteger (int32)

Site ID for which to retrieve notification scripts (optional)

Namestring

Filter the result by notification name (optional)

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

siteIdinteger (int32)

commandnullable string

argumentsnullable string

initialDirectorynullable string

usernamenullable string

Request

Response

Create

Creates a new notification script

POST/api/NotificationScripts

Body

A script can be attached to any of the notifications.

name*nullable string

Script name.

siteIdinteger (int32)

Site ID If the parameter is omitted, the site ID of the Licensing Server will be used.

command*nullable string

Command to execute when invoked.

argumentsnullable string

Command arguments. Possible values: ($CA), ($ENROLLMENTMETHOD), ($FARM-NAME), ($HOSTPOOL), ($LOCATION), ($NOTIFICATION-TIME), ($NOTIFICATION-TYPE), ($PROVIDER), ($RESOURCEGROUP), ($SERVER-ADDRESS), ($SITE-NAME), ($TENANTBROKER), ($TENANTNAME), ($THRESHOLD-DIRECTION), ($THRESHOLD-VALUE), ($TRIGGER-ADDRESS), ($WORKSPACE)

initialDirectorynullable string

Script base directory

usernamenullable string

Execute script as this system user.

passwordnullable string

System user password.

Response

Created

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

siteIdinteger (int32)

commandnullable string

argumentsnullable string

initialDirectorynullable string

usernamenullable string

Request

Response

Get

Retrieves a notification script by ID

GET/api/NotificationScripts/{id}

Path parameters

id*integer (int32)

Notification script ID

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

siteIdinteger (int32)

commandnullable string

argumentsnullable string

initialDirectorynullable string

usernamenullable string

Request

Response

Update

Update script notification by ID.

PUT/api/NotificationScripts/{id}

Path parameters

id*integer (int32)

Script notification ID

Body

Set script notification

namenullable string

A new script name to assign.

commandnullable string

Command to execute when invoked.

argumentsnullable string

Command arguments.

initialDirectorynullable string

Script base directory.

usernamenullable string

Execute script as this system user.

passwordnullable string

System user password.

Response

No Content

Request

Response

Delete

Delete a script notification by ID.

DELETE/api/NotificationScripts/{id}

Path parameters

id*integer (int32)

Script notification ID

Response

No Content

Request

Response

Delete

Delete a script notification by ID.

DELETE/api/NotificationScripts/{id}

Path parameters

id*integer (int32)

Script notification ID

Response

No Content

Request

Response

Get

Retrieves a notification script by ID

GET/api/NotificationScripts/{id}

Path parameters

id*integer (int32)

Notification script ID

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

siteIdinteger (int32)

commandnullable string

argumentsnullable string

initialDirectorynullable string

usernamenullable string

Request

Response

List

Retrieves a list of notification script information

GET/api/NotificationScripts

Query parameters

SiteIdinteger (int32)

Site ID for which to retrieve notification scripts (optional)

Namestring

Filter the result by notification name (optional)

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

siteIdinteger (int32)

commandnullable string

argumentsnullable string

initialDirectorynullable string

usernamenullable string

Request

Response

Update

Update script notification by ID.

PUT/api/NotificationScripts/{id}

Path parameters

id*integer (int32)

Script notification ID

Body

Set script notification

namenullable string

A new script name to assign.

commandnullable string

Command to execute when invoked.

argumentsnullable string

Command arguments.

initialDirectorynullable string

Script base directory.

usernamenullable string

Execute script as this system user.

passwordnullable string

System user password.

Response

No Content

Request

Response

Create

Creates a new notification script

POST/api/NotificationScripts

Body

A script can be attached to any of the notifications.

name*nullable string

Script name.

siteIdinteger (int32)

Site ID If the parameter is omitted, the site ID of the Licensing Server will be used.

command*nullable string

Command to execute when invoked.

argumentsnullable string

initialDirectorynullable string

Script base directory

usernamenullable string

Execute script as this system user.

passwordnullable string

System user password.

Response

Created

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

siteIdinteger (int32)

commandnullable string

argumentsnullable string

initialDirectorynullable string

usernamenullable string

Request

Response

const response = await fetch('/api/NotificationScripts/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

const response = await fetch('/api/NotificationScripts/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:13:58.076Z",
  "timeLastMod": "2024-11-07T10:13:58.076Z",
  "name": "text",
  "command": "text",
  "arguments": "text",
  "initialDirectory": "text",
  "username": "text"
}

const response = await fetch('/api/NotificationScripts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

[
  {
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-11-07T10:13:58.076Z",
    "timeLastMod": "2024-11-07T10:13:58.076Z",
    "name": "text",
    "command": "text",
    "arguments": "text",
    "initialDirectory": "text",
    "username": "text"
  }
]

const response = await fetch('/api/NotificationScripts/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

const response = await fetch('/api/NotificationScripts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "command": "text",
      "name": "text"
    }),
});
const data = await response.json();

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:13:58.076Z",
  "timeLastMod": "2024-11-07T10:13:58.076Z",
  "name": "text",
  "command": "text",
  "arguments": "text",
  "initialDirectory": "text",
  "username": "text"
}