RESTful Api Question/Requests

[DCIM_Support]

Awesome job on the new web api, are there any plans to expand it.

I have a few questions/concerns.

• Connection Between Devices
  • at the moment it seems that you are only able to request power connections between the devices, is there an endpoint to get comm connections or other custom connection.
  • include the connections as part of the asset object just like children that you need to specify include to get the connections.
    • ex: /asset/{id}?include=connections
      • 
        
        • {

              toAssetId:"string",

              id:"string",

              type:"string", //power, comms, custom ??

              cableType:"string", //cat5, fiber multimode, thhn

              terminationType:"string", //rj45,st,sc,bnc,lug, etc...

              conducts:"string" //L1, L2, L3, network, phone, etc

          }
• Include=children behavior
  
  • I would like to be able to use include=children with the /assets endpoint that gets the root location for a user, at the moment i have to call /assets and then /assets/{id}?include=children for every asset
  • If you dont use include=children you get a null value in children which tells  me that i haven't pull the children for that asset but if i use include=children all children have children set to [] which mean empty list, i would suggest returning the empty list for children that don't have any children and null when the child has children but you haven't pull them yet. That way i know when to make another request.
  • Another suggestion is an option to make children recursive if possible so that i dont need to call /asset/{id}?include=children for every descendant to be able to get the full tree.
• /assets/search
  • Is there a way to specify which field to search in?
    • be able to search just the name or in the path ex:
      • /search?q=test&field=name&field=location
      • /search?q=test&fields=name,test
    • Be able to search by path:
      • to get everything under the path"
        • /search?q=Global/NorthAmerica&field=path

(CID:106210687)

[DCIM_Support]

Thanks for the feedback.

The plan is that together with new features there will be new APIs. As more data and functionality is shared between the different clients the existing APIs will also be expanded and new APIs will be created as needed.

• Connection Between Devices

You are correct that only power connections are exposed in our REST API at the moment.

As the connections are related to an asset it could make sense to add this information as an include option as you described.

• Include=children behavior

The "children" include option is not added to /assets for performance reasons. Depending on the users permissions all rooms with their floor mounted equipment could be loaded by this request if that option were available for /assets.

I can see the use-case for indicating whether a child of an asset has children. I will create a feature request for this. In any case I can see that having an empty list is misleading when the asset might have children.

The "children" include option is not recursive for performance reasons. On large solutions it could affect all users when trying to load all assets.

• /assets/search

Currently that are no way to specify a field when searching. A use-case for that feature makes sense though.

Searching in a location makes sense as well. We will keep these suggestions in mind when working on search in the future.

(CID:106210724)

[DCIM_Support]

Hi, has any progress been made for exposing network connections to the REST API?

(CID:110004268)

[DCIM_Support]

This question is closed for comments. You're welcome to start a new topic if you have further comments on this issue.