Jump to

• Request
• Response

Update a Bookmark

put

/api/navigation/Bookmarks/{id}

Updates the properties of an existing bookmark specified by the bookmark ID.

Request

Path Parameters

• id(required): integer(int32)
  The bookmark ID.

  Example:

  1

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BookmarkName(required): string
  Bookmark display name

  Example: Display Instances
• IconCls(required): string
  FontAwesome icon class. Icon class for the bookmark link.

  Example: fa-desktop fa x-menu-item-glyph
• LinkPath(required): string
  The OCUA URL path without the FQDN host name, i.e. the path should start with '/#'.

  Example: /#metric/displayInstances
• UserID(required): integer
  The current logged-in user's ID or a user ID (the issuer must have admin privileges).

  Example: 1

{
    "properties":{
        "BookmarkName":{
            "description":"Bookmark display name",
            "type":"string",
            "example":"Display Instances"
        },
        "LinkPath":{
            "description":"The OCUA URL path without the FQDN host name, i.e. the path should start with '/#'.",
            "type":"string",
            "example":"/#metric/displayInstances"
        },
        "IconCls":{
            "description":"FontAwesome icon class. Icon class for the bookmark link.",
            "type":"string",
            "example":"fa-desktop fa x-menu-item-glyph "
        },
        "UserID":{
            "description":"The current logged-in user's ID or a user ID (the issuer must have admin privileges).",
            "type":"integer",
            "example":1
        }
    },
    "required":[
        "BookmarkName",
        "LinkPath",
        "IconCls",
        "UserID"
    ],
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: object

Show Source

• message: string
  The response message in text.

  Example: Updated record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message in text.",
            "type":"string",
            "example":"Updated record"
        }
    },
    "type":"object"
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top