Get cable

GET

/api/cables/{id}

const url = 'http://localhost:3000/api/cables/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {cookie: 'session=<session>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:3000/api/cables/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --cookie session=<session>

Authorizations

cookieAuth

Parameters

Path Parameters

required

string format: uuid

Responses

200

Success

application/json

object

data

object

required

string format: uuid

label

string

nullable

type

required

string

Allowed values: cat5e cat6 cat6a cat7 cat8 fiber-mm fiber-sm sfp qsfp dac aoc power usb serial other

status

required

string

Allowed values: connected planned decommissioning

color

string

nullable

length

Numeric serialised as string

string

nullable

lengthUnit

string

nullable

Allowed values: m cm ft in

aPortId

required

string format: uuid

bPortId

required

string format: uuid

description

string

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "data": {
    "type": "cat5e",
    "status": "connected",
    "lengthUnit": "m"
  }
}

401

Not authenticated

application/json

object

error

required

string

Example

{
  "error": "Not found"
}

404

Cable not found

application/json

object

error

required

string

Example

{
  "error": "Not found"
}