Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
Response status code: 200
Response body:
{
  "results": {
    "9-STANDARD-5.009.1-MEMBER": {
      "Alarms": "ENABLED",
      "AllowXRoutesets": "DISABLED",
      "BroadcastTCA": "ENABLED",
      "BroadcastTCP": "ENABLED",
      "BroadcastTCR": "ENABLED",
      "BroadcastTFA": "ENABLED",
      "BroadcastTFP": "ENABLED",
      "BroadcastTFR": "ENABLED",
      "CLLI": "N/A",
      "CongestionLevel": "FALSE",
      "CongestionNotifOfUPs": "8",
      "DestinationState": "INACCESSIBLE",
      "LoadshareMode": "NODE_VALUE",
      "RESTAttrCount": 16,
      "RoutesetID": "UNDEFINED",
      "RoutesetState": "ACTIVE",
      "TestState": "IDLE"
    }
  },
  "status": "success"
}

Pagebreak

GET Example 3: Reading VNodes in the MTP3 NA 90

...

Code Block
Response status code: 403
Response body:
{
  "results": {
    "message": "TL1 authentication error",
    "tag": "access-denied",
    "urlpath": "/api/defMTP/MTP3NAManager/MTP3NA"
  },
  "status": "failure"
}

Pagebreak

POST

A POST (create) request is used to create a new object in the DSC (for example, a linkset). When issuing a POST request, the request body must contain attributes required for the object's creation. The DSC responds with status code 200 if the POST request has been successfully created.

...

Code Block
Response status code: 200
Response body:
{
  "results": {},
  "status": "success"
}
 

Confirmation using GET request:

Code Block
Request:
curl -k -u username:password -X GET \
 https://{{service_ip}}:{{service_port}}/api/defMTP/MTP3NAManager/MTP3NA/87/VNodes/VNode/001.002.006
Response status code: 200
Response body:
{
  "results": {
    "87-001.002.006": {
      "BroadcastTFA": "ENABLED",
      "BroadcastTFP": "ENABLED",
      "BroadcastTFR": "ENABLED",
      "CLLI": "",
      "Context": "VNODE 001.002.006",
      "Description": "",
      "MateSTPDistribution": "ENABLED",
      "State": "ACTIVE"
    }
  },
  "status": "success"
}

Pagebreak

Post Example 2: Creating a L2Connection in MTP3 NA 90

...

Code Block
Response status code: 200
Response body:
{
  "results": {},
  "status": "success"
}
 

Confirmation using GET request:

...

The following table list a few of the possible error codes you may come across:

Caption
0Table
1REST API Error Codes

 


Error CodeDescription
403

Forbidden.

Info

May occur if...

  • DSC REST API flag is disabled.
  • TL1 can not authenticate a request based on the username/password provided.
404Page not found. Invalid URL.
500

Internal server error.

Info

May occur if the requested operation is not supported.

...