Jump to

• Request
• Response

Get Links

get

/api/link/Links/

Gets the links that match the specified parameters. If no parameters are specified, all diagrams are returned.

Request

Query Parameters

• filter: object
  The fields to filter the results by. You cannot filter by fields that contain a state.
  This parameter's value uses the following JSON format:
  {
  "property": "property",
  "value": "propertyValue",
  "operator": "operator",
  "conjunction": "conjunction"
  }
  
  If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.

  • conjunction: string
    Default Value: OR

    Allowed Values: [ "AND", "OR" ]

    The conjunction between filters.

    Example: AND
  • operator: string
    Default Value: LIKE

    Allowed Values: [ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]

    The filter operation to use.

    Example: eq
  • property(required): string
    The name of the field to filter on.

    Example: name
  • value(required): string
    The value of the field to filter on.

    Example: test

  {
      "required":[
          "property",
          "value"
      ],
      "properties":{
          "property":{
              "description":"The name of the field to filter on.",
              "type":"string",
              "example":"name"
          },
          "value":{
              "description":"The value of the field to filter on.",
              "type":"string",
              "example":"test"
          },
          "operator":{
              "description":"The filter operation to use.",
              "type":"string",
              "default":"LIKE",
              "enum":[
                  "eq",
                  "ne",
                  "gte",
                  "gt",
                  "lte",
                  "lt",
                  "LIKE",
                  "NOT LIKE",
                  "re",
                  "not re",
                  "NOT IN"
              ],
              "example":"eq"
          },
          "conjunction":{
              "description":"The conjunction between filters.",
              "type":"string",
              "default":"OR",
              "enum":[
                  "AND",
                  "OR"
              ],
              "example":"AND"
          }
      },
      "type":"object"
  }

• limit: integer(int32)
  The number of records to limit results by.

  Example:

  100

• sort: object
  The field and direction to sort results by. You cannot sort by fields that contain a state.
  This parameters value uses the following JSON format:
  {
  "property": "property",
  "direction": "direction"
  }

  • direction(required): string
    Allowed Values: [ "ASC", "DESC" ]

    The direction of the sort.

    Example: ASC
  • property(required): string
    The field to sort on.

    Example: name

  {
      "required":[
          "property",
          "direction"
      ],
      "properties":{
          "property":{
              "description":"The field to sort on.",
              "type":"string",
              "example":"name"
          },
          "direction":{
              "description":"The direction of the sort.",
              "type":"string",
              "enum":[
                  "ASC",
                  "DESC"
              ],
              "example":"ASC"
          }
      },
      "type":"object"
  }

• start: integer(int32)
  The page of results to start from.

  Default Value: 0

  Example:

  1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "description":"The list of links that match the specified parameters.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/linkLinksRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• 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.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The list of links that match the specified parameters.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "description":"The list of links that match the specified parameters.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/linkLinksRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The list of links that match the specified parameters.

Show Source

• Array of: object linkLinksRead

{
    "description":"The list of links that match the specified parameters.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/linkLinksRead"
    }
}

Nested Schema : linkLinksRead

Type: object

Show Source

• LinkIcon: string
  The image used to display for the link.

  Example: fugue/address-book-open.png
• LinkID: integer
  Link ID specified for individual CRUD operations

  Example: 1004
• LinkName: string
  The name for the link.

  Example: Unified Assurance Knowledgebase
• LinkPath: string
  The relative or absolute URL.

  Example: /vendor/mediawiki/index.php/Main_Page
• LinkTypeID: integer
  Unique identifier for the type of link. Allowed Values: - 1 => External (the relative or absolute path separate from Unified Assurance) - 2 => Internal (the relative path to Unified Assurance UI packages) - 3 => Embedded (Embed the whole URL into the link and open the link as a side panel. This is useful if the URL has the same domain but falls outside the OUCA document root. E.g. "https:///saml/")

  Example: 1
• LinkTypeName: string
  Name of the link type.

  Example: External
• OwnerUserGroupID: integer
  Unique identifier for the user group owner of the link.

  Example: 0
• OwnerUserID: integer
  Unique identifier for the user owner of the link.

  Example: 0
• Viewers: array Viewers
  Selection of user groups that have view-only access to link.

{
    "type":"object",
    "properties":{
        "LinkID":{
            "description":"Link ID specified for individual CRUD operations",
            "type":"integer",
            "example":"1004"
        },
        "LinkName":{
            "description":"The name for the link.",
            "type":"string",
            "example":"Unified Assurance Knowledgebase"
        },
        "LinkPath":{
            "description":"The relative or absolute URL.",
            "type":"string",
            "example":"/vendor/mediawiki/index.php/Main_Page"
        },
        "LinkTypeID":{
            "description":"Unique identifier for the type of link.\n\nAllowed Values:\n-  1 => External (the relative or absolute path separate from Unified Assurance)\n-  2 => Internal (the relative path to Unified Assurance UI packages)\n-  3 => Embedded (Embed the whole URL into the link and open the link as a side panel. This is useful if the URL has the same domain but falls outside the OUCA document root. E.g. \"https:///saml/\")",
            "type":"integer",
            "example":"1"
        },
        "LinkTypeName":{
            "description":"Name of the link type.",
            "type":"string",
            "example":"External"
        },
        "LinkIcon":{
            "description":"The image used to display for the link.",
            "type":"string",
            "example":"fugue/address-book-open.png"
        },
        "OwnerUserID":{
            "description":"Unique identifier for the user owner of the link.",
            "type":"integer",
            "example":"0"
        },
        "OwnerUserGroupID":{
            "description":"Unique identifier for the user group owner of the link.",
            "type":"integer",
            "example":"0"
        },
        "Viewers":{
            "description":"Selection of user groups that have view-only access to link.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "UserGroupID":{
                        "description":"User Group ID",
                        "type":"integer"
                    },
                    "UserGroupName":{
                        "description":"User Group Name",
                        "type":"string"
                    }
                }
            },
            "example":[
            ]
        }
    }
}

Nested Schema : Viewers

Type: array

Selection of user groups that have view-only access to link.

Show Source

• Array of: object items

{
    "description":"Selection of user groups that have view-only access to link.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "UserGroupID":{
                "description":"User Group ID",
                "type":"integer"
            },
            "UserGroupName":{
                "description":"User Group Name",
                "type":"string"
            }
        }
    },
    "example":[
    ]
}

Nested Schema : items

Type: object

Show Source

• UserGroupID: integer
  User Group ID
• UserGroupName: string
  User Group Name

{
    "type":"object",
    "properties":{
        "UserGroupID":{
            "description":"User Group ID",
            "type":"integer"
        },
        "UserGroupName":{
            "description":"User Group Name",
            "type":"string"
        }
    }
}

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