Server Attribute

PreviousRDS NextVDI

Last updated 10 months ago

Was this helpful?

Create

Add a Server Attribute for the specified published RD Session Host application.

POST/api/PubItems/{id}/Apps/RDS/ServerAttr/{serverId}

Path parameters

id*integer (int32)

ID of the published RD Session Host application for which the Server Attribute will be added

serverId*integer (int32)

ID of the RD Session Host Server to which the attribute will be added

Body

Specifies the Server Attribute that will be added

serverID*integer (int32)

RDS server ID on which the attributes will be updated.

targetnullable string

Application target file. (i.e. calc.exe, file.txt, etc.)

startInnullable string

Application working directory.

parametersnullable string

Application parameters.

Response

Created

Request

const response = await fetch('/api/PubItems/{id}/Apps/RDS/ServerAttr/{serverId}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "serverID": 1
    }),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Update

Add a Server Attribute for the specified published RD Session Host application.

PUT/api/PubItems/{id}/Apps/RDS/ServerAttr/{serverId}

Path parameters

id*integer (int32)

ID of the published RD Session Host application for which the Server Attribute will be updated

serverId*integer (int32)

ID of the RD Session Host Server for which the attribute will be updated

Body

Specifies the Server Attribute that will be modified

targetnullable string

Application target file. (i.e. calc.exe, file.txt, etc.)

startInnullable string

Application working directory.

parametersnullable string

Application parameters.

Response

No Content

Request

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

Response

{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Delete

Remove a Server Attribute for the specified published RD Session Host application.

DELETE/api/PubItems/{id}/Apps/RDS/ServerAttr/{serverId}

Path parameters

id*integer (int32)

ID of the published RD Session Host application for which the Server Attribute will be deleted

serverId*integer (int32)

ID of the RD Session Host Server for which the attribute will be deleted

Response

No Content

Request

const response = await fetch('/api/PubItems/{id}/Apps/RDS/ServerAttr/{serverId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get

Retrieve Server Attributes for the specified published RD Session Host application.

GET/api/PubItems/{id}/Apps/RDS/ServerAttr

Path parameters

id*integer (int32)

ID of the published RD Session Host application from which the Server Attribute will be shown

Query parameters

Response

Success

Body

parametersnullable string

Application parameters.

startInnullable string

Application working directory.

targetnullable string

Application target file. (i.e. calc.exe, file.txt, etc.).

serverIdinteger (int32)

ID of the server where the application is published.

packagenullable string

The MSIX Package.

packagedAppnullable string

The Application within the MSIX Package.

Request

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

Response

[
  {
    "parameters": "text",
    "startIn": "text",
    "target": "text",
    "serverId": 1,
    "package": "text",
    "packagedApp": "text"
  }
]