Preferred Route

PreviousOS Filters NextRules

Was this helpful?

Delete

delete

Delete a preferred route from the specified published resource.

Path parameters

idinteger · int32required

ID of the published resource to be updated

preferredRouteIdinteger · int32required

ID of the preferred route to be deleted

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/PubItems/{id}/PreferredRoute/{preferredRouteId}'

204

401

404

No Content

List

get

Retrieve a list of preferred routes for the specified published resource.

Path parameters

idinteger · int32required

ID of the published resource to be acquired.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/PubItems/{id}/PreferredRoute'

200

401

404

[
  {
    "id": 1,
    "priority": 1,
    "name": "text",
    "description": "text",
    "enabled": true,
    "referenceType": [
      "3 = Gateway",
      "51 = HALB",
      "83 = Custom"
    ],
    "referenceId": 1
  }
]

Success

Add

post

Add a preferred route to the specified published resource.

Path parameters

idinteger · int32required

ID of the published resource to be updated

Body

Add a client device name to the filter of type 'Client Device Name' for the specified published resource

namestring | nullablerequired

The Name of the Preferred Route

descriptionstring | nullableoptional

Description of the Preferred Route

enabledbooleanoptional

Whether the Preferred Route is enabled or not

referenceTypestring · enumrequired

RAS Publishing Routing Type

Available options:

referenceIdinteger · int32required

Reference ID of the Preferred Route

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/PubItems/{id}/PreferredRoute' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "name": "text",
    "description": "text",
    "enabled": true,
    "referenceType": [
      "3 = Gateway",
      "51 = HALB",
      "83 = Custom"
    ],
    "referenceId": 1
  }'

201

401

404

409

No Content

Created

Update

put

Update the specified preferred route for the specified published resource.

Path parameters

idinteger · int32required

ID of the published resource to be updated

preferredRouteIdinteger · int32required

ID of the preferred route to be updated

Body

namestring | nullableoptional

The Name of the Preferred Route

descriptionstring | nullableoptional

Description of the Preferred Route

enabledboolean | nullableoptional

Whether the Preferred Route is enabled or not

referenceTypestring · enumoptional

RAS Publishing Routing Type

Available options:

referenceIdinteger · int32 | nullableoptional

Reference ID of the Preferred Route

prioritystring · enumoptional

Move Direction.

Available options:

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/PubItems/{id}/PreferredRoute/{preferredRouteId}' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "name": "text",
    "description": "text",
    "enabled": true,
    "referenceType": [
      "3 = Gateway",
      "51 = HALB",
      "83 = Custom"
    ],
    "referenceId": 1,
    "priority": [
      "0 = Up",
      "1 = Down"
    ]
  }'

201

401

404

409

No Content

Created