Preferred Route

List

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

GET/api/PubItems/{id}/PreferredRoute

Path parameters

id*integer (int32)

ID of the published resource to be acquired.

Response

200401404

Success

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

namenullable string

The Name of the Publishing Route

descriptionnullable string

Description of the Publishing Route

enabledboolean

Whether the Publishing Route is enabled or not

referenceTypeRoutingType (enum)

RAS Publishing Routing Type

3 = Gateway,51 = HALB,83 = Custom

referenceIdinteger (int32)

Reference ID of the Publishing Route

Request

JavaScriptCurlPython

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

Response

200401404

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

Add

Add a preferred route to the specified published resource.

POST/api/PubItems/{id}/PreferredRoute

Path parameters

id*integer (int32)

ID of the published resource to be updated

Body

application/json; api-version=1.0

Published item preferred route configuration

name*nullable string

The Name of the Preferred Route

descriptionnullable string

Description of the Preferred Route

enabledboolean

Whether the Preferred Route is enabled or not

referenceType*RoutingType (enum)

RAS Publishing Routing Type

3 = Gateway,51 = HALB,83 = Custom

referenceId*integer (int32)

Reference ID of the Preferred Route

Response

201401404409

Created

Request

JavaScriptCurlPython

const response = await fetch('/api/PubItems/{id}/PreferredRoute', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "name": "text",
      "referenceId": 0,
      "referenceType": [
        "3 = Gateway",
        "51 = HALB",
        "83 = Custom"
      ]
    }),
});
const data = await response.json();

Response

401404409

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

Update

Update the specified preferred route for the specified published resource.

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

Path parameters

id*integer (int32)

ID of the published resource to be updated

preferredRouteId*integer (int32)

ID of the preferred route to be updated

Body

application/json; api-version=1.0

Published item preferred route configuration

namenullable string

The Name of the Preferred Route

descriptionnullable string

Description of the Preferred Route

enablednullable boolean

Whether the Preferred Route is enabled or not

referenceTypeRoutingType (enum)

RAS Publishing Routing Type

3 = Gateway,51 = HALB,83 = Custom

referenceIdnullable integer (int32)

Reference ID of the Preferred Route

priorityMoveDirection (enum)

Move Direction.

0 = Up,1 = Down

Response

201401404409

Created

Request

JavaScriptCurlPython

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

Response

401404409

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

Delete

Delete a preferred route from the specified published resource.

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

Path parameters

id*integer (int32)

ID of the published resource to be updated

preferredRouteId*integer (int32)

ID of the preferred route to be deleted

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/PubItems/{id}/PreferredRoute/{preferredRouteId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

401404

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