Server Attribute

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

application/json; api-version=1.0

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

201401404

Created

Request

JavaScriptCurlPython

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": 0
    }),
});
const data = await response.json();

Response

401404

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

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

application/json; api-version=1.0

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

204401404

No Content

Request

JavaScriptCurlPython

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

401404

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

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

204401404

No Content

Request

JavaScriptCurlPython

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

Response

401404

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

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

200401404

Success

Body

application/json; api-version=1.0

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

JavaScriptCurlPython

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

Response

200401404

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