UNIS Logo
  • UNIS Representations Reference
    • Base Network Resource Representation
    • Node Representation
    • Port Representation
    • Path Representation
    • Link Representation
      • JSON Schema
        • Attributes
        • Example
      • Actions
    • Service Representation
    • Domain Representation
    • Network Representation
    • Topology Representation
    • Metadata Representation
    • Exnode Representation
    • Extent Representation
  • UNIS REST API
UNIS
  • Docs »
  • UNIS Representations Reference »
  • Link Representation
  • View page source

Link Representation¶

Extends Network Resource schema.

A Link object describes that there is a unidirectional/bidirectional connection between two Ports.

A Link SHOULD have and attribute endpoints which is a list of two hyperlinks to Ports if the Link is bidirectional or an object with two attributes source and sink if the Link is unidirectional.

JSON Schema¶

See http://unis.crest.iu.edu/schema/20120709/link.

Attributes¶

The following table contains only the Link specific attributes, for the attributes extended from network resource see Network Resource schema.

Name Value Description
directed boolean true Link is unidirectional. false Link is bidirectional.
capacity number Link’s capacity in bytes per second.
endpoints list/object List of two hyperlinks to Ports if bidirectional. Object of source and sink if unidirectional.

Example¶

The following is an unidirectional Link representation example:

{
    "$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"
        }
    }
}

The following is an bidirectional Link representation example:

{
    "$schema": "http://unis.crest.iu.edu/schema/20120709/link#",
    "id": "link2",
    "selfRef": "https://example.com/links/link2",
    "ts": 1337711394175048,
    "directed": false,
    "capacity": 10000000000,
    "endpoints": [
        {
            "href": "https://example.com/ports/3",
            "ref": "full"
        },
        {
            "href": "https://example.com/ports/4",
            "ref": "full"
        }
    ]
}

Actions¶

  • insert Creates new Link(s).
  • list/query Return all Links registered in the UNIS instance.
  • get Return Link representation.
  • update Update the specified Link.
  • delete Delete a Link.
  • patch patch the specified Link.
Next Previous

© Copyright 2019, Indiana University

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