Retrieves the PhysicalConnectors in the system - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Retrieves the PhysicalConnectors in the system ","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/28ed564a-8eed-31ee-a202-dcc7b5d361f7","info":{"title":"RESTCONF Inventory APIs","description":"RESTCONF Inventory APIs exposed by Inventory service.","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"1.0.0"},"tags":[{"name":"RESTCONF APIs","description":"Points to note: \nThe actual response will,\n- Have namespace prefixed in the attribute name\n- Not have attributes whose values are null\n- Have the attribute names \"-\" separated in some cases\n- Have additional section with firstIndex and lastIndex attributes"}],"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/inventory-restconf-api-overview.md"}},"openapi":"3.1.0","servers":[{"url":"https://{server_ip}:30603/crosswork/inventory/restconf/data/v2","description":"Generated server url"}]},"spec":{"tags":["RESTCONF APIs"],"summary":"Retrieves the PhysicalConnectors in the system ","description":"\u003cb\u003eBatch Retrieval\u003c/b\u003e \nThe default max batch size for retrieval is set to 100 and maximum 100 objects can be retrieved. \n\u003cb\u003e.startIndex=<value>\u003c/b\u003e 0 based index as a start index of the data to be retrieved \n\u003cb\u003e.maxCount=<value>\u003c/b\u003e Maximum number of objects to be retrieved \n\nAdditional filters can be provided as URL parameters e.g. \n\u003cb\u003efdn=<value>\u003c/b\u003e Fully Distinguished Name (FDN) of the PhysicalConnector to retrieve, e.g. 'MD=CISCO_EMS!ND=\\\u003cnodename\u003e!EQ=name=\u003cequipment_name\u003e!PC=\u003cphysicalconnector_name\u003e' \nIt can be obtained from physical connector API response '/crosswork/inventory/restconf/data/v2/resource-physical:physical-connector' \nFor e.g. in the json format of the response, \"eq.fdn\": \"MD=CISCO_EMS!ND=RON_NCS5700_14.cisco-lab.com!EQ=name=0/0-Slice 0 J2C Port Module #28;partnumber=N/A!PC=0/0-TwentyFiveGigE0/0/0/28/0\" \n\n\u003cb\u003ename=<value>\u003c/b\u003e Name of the PhysicalConnector to retrieve (not unique), e.g. '0/0-TwentyFiveGigE0/0/0/28/0' \nIt can be obtained from physical connector API response '/crosswork/inventory/restconf/data/v2/resource-physical:physical-connector' \nFor e.g. in the json format of the response, \"fdtn.name\": \"0/0-TwentyFiveGigE0/0/0/28/0\"\n\n\u003cb\u003edescription=<value>\u003c/b\u003e Description of the PhysicalConnector to retrieve (not unique), e.g. '25GE Breakout Port' \nIt can be obtained from physical connector API response '/crosswork/inventory/restconf/data/v2/resource-physical:physical-connector' \nFor e.g. in the json format of the response, \"fdtn.description\": \"25GE Breakout Port\"\n\n\u003cb\u003e<attribute>=<value>\u003c/b\u003e Uses any non-collection attribute to retrieve PhysicalConnector object(s) \n\u003cb\u003eNote:\u003c/b\u003e Attributes not supported in filter [containing-equipment]","operationId":"getPhysicalConnectorResource","responses":{"200":{"description":"Success with response message-body","content":{"application/json":{"schema":{"type":"object","description":"response","xml":{"name":"response-message","namespace":"urn:cisco:params:xml:ns:yang:nrf-common:v1","prefix":"ns14"},"properties":{"header":{"type":"object","description":"header","properties":{"firstIndex":{"type":"integer","format":"int64","description":"firstIndex","xml":{"prefix":"ns14"}},"lastIndex":{"type":"integer","format":"int64","description":"lastIndex","xml":{"prefix":"ns14"}}},"xml":{"prefix":"ns14"},"$$ref":"#/components/schemas/Header"},"data":{"type":"object","description":"data","xml":{"prefix":"ns14"},"properties":{"physical-connector":{"type":"array","description":"termination point","items":{"type":"object","description":"PhysicalConnector","xml":{"name":"physical-connector","prefix":"ns13"},"properties":{"description":{"type":"string","description":"description","xml":{"name":"description","prefix":"ns12"}},"name":{"type":"string","description":"name","xml":{"name":"name","prefix":"ns12"}},"owningEntityId":{"type":"string","description":"owningEntityId"},"entityTag":{"type":"string","description":"Generic tag"},"debugMode":{"type":"boolean","description":"Debug mode"},"instanceId":{"type":"integer","description":"Instance id","xml":{"name":"instanceId","prefix":"ns13"},"format":"int64"},"businessKey":{"type":"string","description":"Business key"},"aliasName":{"type":"string","description":"Alias name"},"connectorType":{"type":"string","description":"Connector type"},"entAliasLogicalIndexOrZero":{"type":"string","description":"entAliasLogicalIndexOrZero"},"entPhysicalContainedIn":{"type":"string","description":"entPhysicalContainedIn"},"entPhysicalIndex":{"type":"string","description":"entPhysicalIndex"},"restconfFdn":{"type":"string","description":"restconfFdn"},"vendorEquipmentType":{"type":"string","description":"vendorEquipmentType"},"fdn":{"type":"string","description":"fdn","xml":{"name":"fdn","prefix":"ns13"}},"equipment":{"type":"string","description":"equipment"}},"$$ref":"#/components/schemas/PhysicalConnector"}}},"$$ref":"#/components/schemas/DataPc"}},"$$ref":"#/components/schemas/ResponseMessagePc"},"examples":{"example":{"summary":"Sample response","value":{"com.response-message":{"com.header":{"com.firstIndex":0,"com.lastIndex":1},"com.data":{"eq.physical-connector":[{"fdtn.description":"A900-IMA8Z","fdtn.name":"TenGigabitEthernet0/5/0","eq.containing-equipment":"MD=CISCO_EMS!ND=ASR903-47.cisco-lab!EQ=name=subslot 0/5 transceiver 0;partnumber=N/A","eq.fdn":"MD=CISCO_EMS!ND=ASR903-47.cisco-lab!EQ=name=subslot 0/5 transceiver 0;partnumber=N/A!PC=TenGigabitEthernet0/5/0","eq.instanceId":449449},{"fdtn.description":"Network Management Ethernet","fdtn.name":"NME R0","eq.containing-equipment":"MD=CISCO_EMS!ND=ASR903-47.cisco-lab!EQ=name=module R0;partnumber=68-5552-02","eq.fdn":"MD=CISCO_EMS!ND=ASR903-47.cisco-lab!EQ=name=module R0;partnumber=68-5552-02!PC=NME R0","eq.instanceId":449450}]}}},"$$ref":"#/components/examples/GetPhysicalConnectorJson"}}},"application/xml":{"schema":{"type":"object","description":"response","xml":{"name":"response-message","namespace":"urn:cisco:params:xml:ns:yang:nrf-common:v1","prefix":"ns14"},"properties":{"header":{"type":"object","description":"header","properties":{"firstIndex":{"type":"integer","format":"int64","description":"firstIndex","xml":{"prefix":"ns14"}},"lastIndex":{"type":"integer","format":"int64","description":"lastIndex","xml":{"prefix":"ns14"}}},"xml":{"prefix":"ns14"},"$$ref":"#/components/schemas/Header"},"data":{"type":"object","description":"data","xml":{"prefix":"ns14"},"properties":{"physical-connector":{"type":"array","description":"termination point","items":{"type":"object","description":"PhysicalConnector","xml":{"name":"physical-connector","prefix":"ns13"},"properties":{"description":{"type":"string","description":"description","xml":{"name":"description","prefix":"ns12"}},"name":{"type":"string","description":"name","xml":{"name":"name","prefix":"ns12"}},"owningEntityId":{"type":"string","description":"owningEntityId"},"entityTag":{"type":"string","description":"Generic tag"},"debugMode":{"type":"boolean","description":"Debug mode"},"instanceId":{"type":"integer","description":"Instance id","xml":{"name":"instanceId","prefix":"ns13"},"format":"int64"},"businessKey":{"type":"string","description":"Business key"},"aliasName":{"type":"string","description":"Alias name"},"connectorType":{"type":"string","description":"Connector type"},"entAliasLogicalIndexOrZero":{"type":"string","description":"entAliasLogicalIndexOrZero"},"entPhysicalContainedIn":{"type":"string","description":"entPhysicalContainedIn"},"entPhysicalIndex":{"type":"string","description":"entPhysicalIndex"},"restconfFdn":{"type":"string","description":"restconfFdn"},"vendorEquipmentType":{"type":"string","description":"vendorEquipmentType"},"fdn":{"type":"string","description":"fdn","xml":{"name":"fdn","prefix":"ns13"}},"equipment":{"type":"string","description":"equipment"}},"$$ref":"#/components/schemas/PhysicalConnector"}}},"$$ref":"#/components/schemas/DataPc"}},"$$ref":"#/components/schemas/ResponseMessagePc"},"examples":{"example":{"summary":"Sample response","value":{"header":{"firstIndex":0,"lastIndex":1},"data":{"physical-connector":[{"ns12:description":"A900-IMA8Z","ns12:name":"TenGigabitEthernet0/5/0","ns13:containing-equipment":"MD=CISCO_EMS!ND=ASR903-47.cisco-lab!EQ=name=subslot 0/5 transceiver 0;partnumber=N/A","ns13:fdn":"MD=CISCO_EMS!ND=ASR903-47.cisco-lab!EQ=name=subslot 0/5 transceiver 0;partnumber=N/A!PC=TenGigabitEthernet0/5/0","ns13:instanceId":449449},{"ns12:description":"Network Management Ethernet","ns12:name":"NME R0","ns13:containing-equipment":"MD=CISCO_EMS!ND=ASR903-47.cisco-lab!EQ=name=module R0;partnumber=68-5552-02","ns13:fdn":"MD=CISCO_EMS!ND=ASR903-47.cisco-lab!EQ=name=module R0;partnumber=68-5552-02!PC=NME R0","ns13:instanceId":449450}]}},"$$ref":"#/components/examples/GetPhysicalConnectorXml"}}}}},"400":{"description":"Bad Request - Invalid request"},"401":{"description":"Unauthorized. The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden. The server recognizes the authentication credentials, but the client is not authorized to perform this request."},"500":{"description":"Internal Server Error - operation-failed"}},"method":"get","path":"/resource-physical:physical-connector"}}