ProductsSupportPartnersDocumentation

Server Attribute

Create

post

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

Path parameters
idinteger · int32Required

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

serverIdinteger · int32Required

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

Body

Add a server to the list of servers where the Publishing is being hosted

serverIDinteger · int32Required

RDS server ID on which the attributes will be updated.

targetstring | nullableOptional

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

startInstring | nullableOptional

Application working directory.

parametersstring | nullableOptional

Application parameters.

Responses
201
Created
post
POST /api/PubItems/{id}/Apps/RDS/ServerAttr/{serverId} HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 67

{
  "serverID": 1,
  "target": "text",
  "startIn": "text",
  "parameters": "text"
}
No content

Update

put

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

Path parameters
idinteger · int32Required

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

serverIdinteger · int32Required

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

Body

Update a list of individual servers the published application is published from

targetstring | nullableOptional

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

startInstring | nullableOptional

Application working directory.

parametersstring | nullableOptional

Application parameters.

Responses
204
No Content
put
PUT /api/PubItems/{id}/Apps/RDS/ServerAttr/{serverId} HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 54

{
  "target": "text",
  "startIn": "text",
  "parameters": "text"
}
No content

Delete

delete

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

Path parameters
idinteger · int32Required

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

serverIdinteger · int32Required

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

Responses
204
No Content
delete
DELETE /api/PubItems/{id}/Apps/RDS/ServerAttr/{serverId} HTTP/1.1
Host: 
Accept: */*

No content

Get

get

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

Path parameters
idinteger · int32Required

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

Query parameters
serverIdinteger · int32Optional

ID of the RD Session Host Server from which attributes will be shown

Responses
200
Success
application/json; api-version=1.0
get
GET /api/PubItems/{id}/Apps/RDS/ServerAttr HTTP/1.1
Host: 
Accept: */*

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

Was this helpful?