Jump to

• Request
• Response
• Examples

Get All User Navigation Links

get

/rest/v16/userNavigationLinks

Use this endpoint to retrieve the user navigation links defined in the Navigation Menu for a site.

Request

Query Parameters

• excludeLinks: string
  Exclude specified link types.

  Allowed Values: [ "self", "child", "parent", "canonical", "next", "prev", "related" ]
• fields: string
  Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
• group: string
  Criteria to filter the links by group.

  Allowed Values: [ "ADMIN", "COMMERCE", "DATA_TABLES", "SUBHEADER", "SUBFOOTER", "QUICK_REGISTRATION" ]
• limit: integer
  The requested page size, which limits the number of elements the collection should max return.
• offset: integer
  The offset of the page. By default, offset is 0, which means first page will be returned.
• subGroup: string
  Criteria to filter the links by sub group.

  Allowed Values: [ "LEFT", "CENTER", "RIGHT" ]
• totalResults: boolean
  Specifies that the total count of records should be included in the response when doing pagination.

Back to Top

Response

Supported Media Types

• application/json

Default Response

List of user navigation links.

Body ()

Root Schema : userNavigationLink-collection

Type: object

Show Source

• count: integer
  The number of resource instances returned in the current range.
• hasMore: boolean
  Returns true if more resources are available on the server than the subset returned in current page.
• items: array User Navigation Link Collection
  Title: User Navigation Link Collection

  User navigation link collection
• limit: integer
  The actual paging size used by the server.
• links: array links
• navigationType: string
  Title: Navigation Type

  Navigation type. Possible values are Top Navigation, Side Navigation or Alta Navigation.
• offset: integer
  The offset used in the current page.
• siteUrl: string
  Title: Site Url

  The base URI for the site to be used with the URLs to fully define the links.
• totalResults: integer
  Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "type":"object",
    "properties":{
        "navigationType":{
            "type":"string",
            "description":"Navigation type. Possible values are Top Navigation, Side Navigation or Alta Navigation.",
            "title":"Navigation Type"
        },
        "siteUrl":{
            "type":"string",
            "description":"The base URI for the site to be used with the URLs to fully define the links.",
            "title":"Site Url"
        },
        "offset":{
            "type":"integer",
            "description":"The offset used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "totalResults":{
            "type":"integer",
            "description":"Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page."
        },
        "items":{
            "type":"array",
            "description":"User navigation link collection",
            "title":"User Navigation Link Collection",
            "items":{
                "$ref":"#/definitions/userNavigationLink"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : User Navigation Link Collection

Type: array

Title: User Navigation Link Collection

User navigation link collection

Show Source

• Array of: object userNavigationLink

{
    "type":"array",
    "description":"User navigation link collection",
    "title":"User Navigation Link Collection",
    "items":{
        "$ref":"#/definitions/userNavigationLink"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object reference links
  Title: reference links

  Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : userNavigationLink

Type: object

Show Source

• displayType: string
  Title: Link Display

  Display type of the navigation link. Possible values are LABEL, ICON or BOTH.
• group: string
  Title: Link Group

  Group of the navigation link. Possbile values are ADMIN, SUBHEADER, SUBFOOTER, COMMERCE, QUICK_REGISTRATION.
• iconPath: string
  Title: Link Icon

  Path of the navigation link image file.
• iconPosition: string
  Title: Link Icon Position

  Position of the icon to be displayed with respect to label. Possible values are LEFT_OF_LABEL, RIGHT_OF_LABEL.
• label: string
  Title: Link Label

  Label of the navigation link as defined.
• linkType: string
  Title: Link Type

  Navigation link Type. Possible values are TAB or LINK.
• order: integer
  Title: Link Order

  Sequence number within the group and subgroup.
• subGroup: string
  Title: Link Sub Group

  Sub group of the navigation link. Possible values are LEFT, RIGHT, CENTER.
• url: string
  Title: Link URL

  Relative path of the link as defined.

{
    "type":"object",
    "properties":{
        "label":{
            "type":"string",
            "description":"Label of the navigation link as defined.",
            "title":"Link Label"
        },
        "url":{
            "type":"string",
            "description":"Relative path of the link as defined.",
            "title":"Link URL"
        },
        "linkType":{
            "type":"string",
            "description":"Navigation link Type. Possible values are TAB or LINK.",
            "title":"Link Type"
        },
        "displayType":{
            "type":"string",
            "description":"Display type of the navigation link. Possible values are LABEL, ICON or BOTH.",
            "title":"Link Display"
        },
        "group":{
            "type":"string",
            "description":"Group of the navigation link. Possbile values are ADMIN, SUBHEADER, SUBFOOTER, COMMERCE, QUICK_REGISTRATION.",
            "title":"Link Group"
        },
        "subGroup":{
            "type":"string",
            "description":"Sub group of the navigation link. Possible values are LEFT, RIGHT, CENTER.",
            "title":"Link Sub Group"
        },
        "iconPath":{
            "type":"string",
            "description":"Path of the navigation link image file.",
            "title":"Link Icon"
        },
        "iconPosition":{
            "type":"string",
            "description":"Position of the icon to be displayed with respect to label. Possible values are LEFT_OF_LABEL, RIGHT_OF_LABEL.",
            "title":"Link Icon Position"
        },
        "order":{
            "type":"integer",
            "description":"Sequence number within the group and subgroup.",
            "title":"Link Order"
        }
    }
}

Nested Schema : reference links

Type: object

Title: reference links

Reference links for the Parent, Self, Children and Related as applicable

Show Source

• href: string
  Title: URL to the related object

  URL to the related object
• name: string
• rel: string
  Title: Link Relationship to the current object

  Default Value: self

  Link Relationship to the current object

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link Relationship to the current object",
            "title":"Link Relationship to the current object",
            "default":"self"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"URL to the related object"
        },
        "name":{
            "type":"string"
        }
    },
    "title":"reference links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Back to Top

Examples

The following example shows how to retrieve the user navigation links defined in the Navigation Menu for a site by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Content-type: application/json" -H "Accept: application/json"
https://sitename.oracle.com/rest/v16/userNavigationLinks

Response Body Sample

{
  "limit": 50,
  "offset": 0,
  "count": 7,
  "totalResults": 7,
  "hasMore": false,
  "navigationType": "ALTA_NAVIGATION",
  "siteUrl": "http://sitename.oracle.com",
  "items": [{
      "label": "Users",
      "url": "/admin/users/list_users.jsp?_bm_trail_refresh_=true",
      "linkType": "LINK",
      "displayType": "ICON",
      "group": "ADMIN",
      "subGroup": "CENTER",
      "iconPath": "/files/Icons/icon-user.png",
      "iconPosition": "LEFT_OF_THE_LABEL",
      "order": 1,
      "isInternal":true
    }, {
      "label": "Parts",
      "url": "/admin/parts/manage_parts.jsp?_bm_trail_refresh_=true",
      "linkType": "LINK",
      "displayType": "ICON",
      "group": "ADMIN",
      "subGroup": "CENTER",
      "iconPath": "/files/Icons/icon_product2.png",
      "iconPosition": "LEFT_OF_THE_LABEL",
      "order": 2,
      "isInternal":false
    }
}

Back to Top