UNIS Logo
  • UNIS Representations Reference
  • UNIS REST API
    • Introduction
    • UNIS REST API Reference
      • Node
      • Port
      • Link
        • List/Query Links
        • Get Link
        • Insert Link
        • Update Link
        • Delete Link
        • Patch Link
      • Path
      • Service
      • Domain
      • Network
      • Topology
      • Metadata
UNIS
  • Docs »
  • UNIS REST API »
  • UNIS REST API Reference »
  • Link »
  • Get Link
  • View page source

Get Link¶

Returns the specified Link.

Request¶

HTTP Request:

GET https://example.com/links/{id}

where id is the Link’s identifier.

Query Parameters¶

All the attributes defined in, or extended from, Link can be queried by the mechanisms defined in UNIS query language.

Query on a single Link is executed over the current and the older versions of the Link’s representation. The returned result when query is used is a list of Links.

Request Body¶

Empty

Response¶

Response Status Codes¶

  • 200 OK A Link representation is returned.
  • 304 Not modified The client’s cached version of the representation is still up to date.
  • 401 Unauthorized The supplied credentials are not enough read the Link.
  • 404 Not found No Link with the specified id exists.
  • 500 Internal Server Error Link couldn’t be read, try again.

Response Body¶

If successful, a Link representation is returned. If query is used the returned result is list of Links representations.

Examples¶

The examples include only important HTTP header fields for clarity.

Get Link¶

Request:

GET https://example.com/links/link1
Content-Type: application/perfsonar+json
Accept: application/perfsonar+json
Connection: close

Response:

HTTP/1.1 200 OK
Content-Type: application/perfsonar+json; profile=http://unis.crest.iu.edu/schema/20120709/link#

{
    "$schema": "http://unis.crest.iu.edu/schema/20120709/link#",
    "id": "link1",
    "selfRef": "https://example.com/links/link1"
    "ts": 1337711394175048,
    "directed": true,
    "capacity": 10000000000,
    "endpoints": {
        "source": {
            "href": "https://example.com/ports/1",
            "ref": "full"
        },
        "sink": {
            "href": "https://example.com/ports/2",
            "ref": "full"
        }
    }
}
Next Previous

© Copyright 2019, Indiana University

Built with Sphinx using a theme provided by Read the Docs.