Preferred Route

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

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/PubItems/{id}/PreferredRoute

HTTPcURLJavaScriptPython

GET /api/PubItems/{id}/PreferredRoute HTTP/1.1
Host: 
Accept: */*

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

Add

post

Add a preferred route to the specified published resource.

Path parameters

idinteger · int32Required

ID of the published resource to be updated

Body

application/json; api-version=1.0

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

Possible values:

referenceIdinteger · int32Required

Reference ID of the Preferred Route

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

/api/PubItems/{id}/PreferredRoute

HTTPcURLJavaScriptPython

POST /api/PubItems/{id}/PreferredRoute HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 125

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

No content

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

application/json; api-version=1.0

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

Possible values:

referenceIdinteger · int32 | nullableOptional

Reference ID of the Preferred Route

prioritystring · enumOptional

Move Direction.

Possible values:

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

put

/api/PubItems/{id}/PreferredRoute/{preferredRouteId}

HTTPcURLJavaScriptPython

PUT /api/PubItems/{id}/PreferredRoute/{preferredRouteId} HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 158

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

No content

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

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

/api/PubItems/{id}/PreferredRoute/{preferredRouteId}

HTTPcURLJavaScriptPython

DELETE /api/PubItems/{id}/PreferredRoute/{preferredRouteId} HTTP/1.1
Host: 
Accept: */*

No content