Retrieve Bill of Materials - Cisco Optical Network Planner (CONP) API

{"type":"api","title":"Retrieve Bill of Materials","meta":{"id":"/apps/pubhub/media/conp-api/b9861fe2e1aca02803f44af045abe0e5033ce2e9/262737b2-b3c2-32cd-b07b-fdbdcd23918f","info":{"title":"Cisco Optical Network Planner API","description":"Cisco Optical Network Planner api documentation","contact":{},"license":{"name":"CONP-AE-License","url":"http://www.cisco.com"},"version":"24.3.1+2024.10.03"},"x-parser-conf":{"overview":{"markdownPath":"reference/overview.md"}},"openapi":"3.0.1","securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT Authentication Token"}}},"spec":{"description":"Retrieves the Bill of Materials (BOM) reports that provides information about the components required for a specific network.","tags":["network-controller"],"operationId":"getNetworkBomPage","summary":"Retrieve Bill of Materials","parameters":[{"name":"networkId","description":"Network UID","in":"path","required":true,"schema":{"type":"string"}},{"name":"delta","description":"NetworkUID of the network that need to be compared","in":"query","required":false,"schema":{"type":"string"}},{"name":"searchString","description":"Search String based on SearchType","in":"query","required":false,"schema":{"type":"string"}},{"name":"searchType","description":"Search type - contains or equals","in":"query","required":false,"schema":{"type":"string"}},{"name":"pageable","description":"Pageable Parameters","in":"query","required":true,"schema":{"type":"object","properties":{"size":{"format":"int32","maximum":10,"description":"Size","type":"integer","minimum":1,"example":6},"pageSize":{"maximum":10,"description":"Page Size","type":"integer","minimum":1,"example":5},"page":{"format":"int32","description":"Page","type":"integer","minimum":0,"example":123},"sort":{"description":"Sort","type":"array","items":{"type":"string"},"example":["1"]}},"description":"Pageable object","$$ref":"#/components/schemas/Pageable"}}],"responses":{"200":{"description":"OK","headers":{"Date":{"description":"The date and time when the response was generated","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \\d{1,2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \\d{4} \\d{2}:\\d{2}:\\d{2} GMT$","type":"string","example":"Thu, 15 Aug 2024 09:48:17 GMT"}},"Cache-Control":{"description":"Directives for caching mechanisms in responses","schema":{"type":"string","example":"private, no-cache, no-store, max-age=0, must-revalidate"}},"TrackingID":{"description":"A unique tracking ID for this request","schema":{"type":"string","example":"23e3c120"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"number":{"format":"int32","description":"Integer Number","type":"integer","example":123},"last":{"description":"True or False","type":"boolean","example":true},"size":{"format":"int32","description":"Size","type":"integer","example":123},"numberOfElements":{"format":"int32","description":"Number of Elements","type":"integer","example":123},"totalPages":{"format":"int32","description":"Total Pages","type":"integer","example":123},"pageable":{"description":"Pageable","example":{"paged":true,"pageNumber":1},"type":"object","properties":{"paged":{"description":"Paged","type":"boolean","example":true},"pageNumber":{"format":"int32","description":"Page Number","type":"integer","example":123},"offset":{"format":"int64","description":"Offset","type":"integer","example":123},"pageSize":{"format":"int32","description":"Page Size","type":"integer","example":123},"unpaged":{"description":"Unpaged","type":"boolean","example":true},"links":{"description":"Links","type":"array","items":{"type":"object","properties":{"method":{"description":"Method","type":"string","example":"OTNDemand"},"rel":{"description":"Rel","type":"string","example":"A"},"href":{"description":"Href","type":"string","example":"A"}},"description":"LinkDTO object","$$ref":"#/components/schemas/LinkDTO"},"example":[{"method":"update"}]},"sort":{"description":"Sort","example":{"unsorted":false},"type":"object","properties":{"unsorted":{"description":"Unsorted","type":"boolean","example":true},"sorted":{"description":"Sorted","type":"boolean","example":true},"empty":{"description":"True or False","type":"boolean","example":true}},"$$ref":"#/components/schemas/Sort"}},"$$ref":"#/components/schemas/PageableObject"},"sort":{"description":"Sort","example":{"unsorted":false},"type":"object","properties":{"unsorted":{"description":"Unsorted","type":"boolean","example":true},"sorted":{"description":"Sorted","type":"boolean","example":true},"empty":{"description":"True or False","type":"boolean","example":true}},"$$ref":"#/components/schemas/Sort"},"first":{"description":"True or False","type":"boolean","example":true},"content":{"description":"content","type":"array","items":{"type":"object","properties":{"UID":{"description":"UID","type":"string","example":"B008-06c86f93-dc95-4277-b54a-ae9fa"},"total":{"description":"Total","type":"number","example":123.45},"label":{"description":"Label","type":"string","example":"BOM"},"logicalSites":{"description":"Logical Sites","example":{"oTN":[{"UID":"34567","label":"site1","total":455.56}]},"type":"object","properties":{"NCS1k":{"description":"NCS1k","type":"array","items":{"type":"object","properties":{"UID":{"description":"UID","type":"string","example":"d62ed00c-03cf-445b-b6e0-78f01de68547"},"BOM":{"description":"BOM","type":"array","items":{"description":"NCS1KBOM object","type":"object","properties":{"GPL":{"description":"GPL","type":"number","example":123.45},"description":{"description":"Tells the Description","type":"string","example":"Empty slot Filler Panel"},"discount":{"format":"double","description":"Discount","type":"number","example":123.45},"PID":{"description":"PID","type":"string","example":"15454-BLANK="},"materialID":{"description":"Material ID","type":"string","example":"11311880"},"equipmentType":{"description":"Equipment Type","type":"string","example":"Common Equipment"},"categoryType":{"description":"Category Type","type":"string","example":"A"},"CLEI":{"description":"Clei","type":"string","example":"45"},"extendedPrice":{"description":"Extended Price","type":"number","example":123.45},"price":{"description":"Price","type":"number","example":123.45},"qty":{"format":"int64","description":"Quantity","type":"integer","example":123},"manuallyAdded":{"description":"True or False","type":"boolean","example":true},"id":{"description":"ID","type":"string","example":"123"}},"$$ref":"#/components/schemas/NCS1KBOM"},"example":[{"CLEI":"CHANGE-ME-","PID":"NCS1K4-LC-FILLER=","qty":2,"GPL":1,"description":"Network Convergence System 1004 Filler","price":1,"manuallyAdded":false}]},"total":{"description":"Total","type":"number","example":123.45},"label":{"description":"Label","type":"string","example":"bom"}},"description":"NCS1KBOMsDTO object","$$ref":"#/components/schemas/NCS1KBOMsDTO"},"example":[{"UID":"34567","label":"site1","total":455.56}]},"L0Site":{"description":"L0 Site","type":"array","items":{"type":"object","properties":{"UID":{"description":"UID","type":"string","example":"709e3fde-76a2-4348-982a-513efa48ec46"},"total":{"description":"Total","type":"number","example":123.45},"NCS1010BOM":{"description":"NCS1010 BOM","type":"array","items":{"description":"NCS1010BOM object","type":"object","properties":{"GPL":{"description":"GPL","type":"number","example":123.45},"description":{"description":"Tells the Description","type":"string","example":"Network Convergence System 1001 line system 3 slots"},"discount":{"format":"double","description":"Discount","type":"number","example":123.45},"PID":{"description":"PID","type":"string","example":"NCS1001-K9="},"materialID":{"description":"Material ID","type":"string","example":"M"},"equipmentType":{"description":"Equipment Type","type":"string","example":"CommonUnit"},"categoryType":{"description":"Category Type","type":"string","example":"CommonUnit"},"CLEI":{"description":"Clei","type":"string","example":"N/A"},"extendedPrice":{"description":"Extended Price","type":"number","example":123.45},"price":{"description":"Price","type":"number","example":123.45},"qty":{"format":"int64","description":"Quantity","type":"integer","example":123},"manuallyAdded":{"description":"True or False","type":"boolean","example":true},"id":{"description":"ID","type":"string","example":"79527-74d9-45f2-a5"}},"$$ref":"#/components/schemas/NCS1010BOM"},"example":[{"PID":"NCS2K-MF-1RU=","description":"Mechanical Frame - 4 slots - 1 RU","GPL":508.2,"qty":2,"price":254.1,"materialID":""}]},"label":{"description":"Label","type":"string","example":"label1"},"DWDMBOM":{"description":"DWDM BOM","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID","example":"5ee9c8b0a11259000177fb3d"},"materialID":{"type":"string","description":"Material ID","example":"11311880"},"CLEI":{"type":"string","description":"CLEI","example":"WMPQAXNUAB"},"equipmentType":{"type":"string","description":"Equipment Type","example":"Common Equipment"},"PID":{"type":"string","description":"PID","example":"15454-BLANK="},"qty":{"type":"integer","format":"int64","description":"Quantity","example":1},"GPL":{"type":"number","description":"GPL","example":2250},"description":{"type":"string","description":"Tells the Description","example":"Empty slot Filler Panel"},"discount":{"type":"number","format":"double","description":"Discount","example":5},"extendedPrice":{"type":"number","description":"Extended Price","example":2250},"price":{"type":"number","description":"Price","example":2250},"manuallyAdded":{"type":"boolean","description":"True or False","example":false},"categoryType":{"type":"string","description":"Category Type","example":"CommonUnit"}},"description":"DWDMBOM object","$$ref":"#/components/schemas/DWDMBOM"},"example":[{"PID":"15216-LC-LC-10=","description":"Fiber patchcord - LC to LC - 6m","GPL":360,"qty":4,"price":90,"materialID":"11321835","CLEI":"N/A","equipmentType":"Common Equipment"}]}},"description":"L0SiteBOMsDTO object","$$ref":"#/components/schemas/L0SiteBOMsDTO"},"example":[{"UID":"34567","label":"site1","total":455.56}]},"OTN":{"description":"OTN","type":"array","items":{"type":"object","properties":{"UID":{"description":"UID","type":"string","example":"c84d3a5b-c7a3-4bcd-a0d5-acfcc0ee2f2d"},"BOM":{"description":"BOM","type":"array","items":{"type":"object","properties":{"GPL":{"description":"GPL","type":"number","example":123.45},"description":{"description":"Tells the Description","type":"string","example":"NCS 1014 chassis with timing support"},"discount":{"format":"double","description":"Discount","type":"number","example":123.45},"PID":{"description":"PID","type":"string","example":"NCS1004_QPSK_SP_16QAM_200G_27%SDFEC_60GBd"},"materialID":{"description":"Material ID","type":"string","example":"3456"},"equipmentType":{"description":"Equipment Type","type":"string","example":"OTNBOM"},"categoryType":{"description":"Category Type","type":"string","example":"CommonUnit"},"CLEI":{"description":"Clei","type":"string","example":"N/A"},"extendedPrice":{"description":"Extended Price","type":"number","example":123.45},"price":{"description":"Price","type":"number","example":123.45},"qty":{"format":"int64","description":"Quantity","type":"integer","example":123},"manuallyAdded":{"description":"True or False","type":"boolean","example":true},"id":{"description":"ID","type":"string","example":"a9aabb77-4707-474a-ab5b-947320abd9c7"}},"description":"OTNBOM object","$$ref":"#/components/schemas/OTNBOM"},"example":[{"UID":"34567","label":"site1","total":455.56}]},"total":{"description":"Total","type":"number","example":123.45},"label":{"description":"Label","type":"string","example":"label-1"}},"description":"OTNBOMsDTO object","$$ref":"#/components/schemas/OTNBOMsDTO"},"example":[{"UID":"34567","label":"site1","total":455.56}]}},"$$ref":"#/components/schemas/LogicalSitesBOMsDTO"}},"description":"SiteBOMsDTO object","$$ref":"#/components/schemas/SiteBOMsDTO"},"example":[{"UID":"34567","label":"site1","total":455.56}]},"totalElements":{"format":"int64","description":"Total Elements","type":"integer","example":123},"empty":{"description":"True or False","type":"boolean","example":true}},"description":"PageSiteBOMsDTO object","$$ref":"#/components/schemas/PageSiteBOMsDTO"},"example":{"content":[{"UID":"bb918818-9267-4223-81e3-9013c3b8b147","label":"Site-1","total":200382.89,"logicalSites":{"L0Site":[{"UID":"fd6087b7-3840-41b1-a2cf-d18a5affa621","label":"Site-1","total":200382.89,"DWDMBOM":[],"NCS1010BOM":[{"materialID":"3456","CLEI":"N/A","PID":"NCS1010-SA=","qty":1,"GPL":3015,"description":"NCS 1010 Shelf Assembly","price":3015,"manuallyAdded":false,"categoryType":"Chassis"}]}]}}],"totalElements":2,"last":true,"totalPages":1,"first":true,"numberOfElements":2,"size":8,"number":0,"empty":false}}}},"400":{"description":"Bad Request","headers":{"Date":{"description":"The date and time when the response was generated","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \\d{1,2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \\d{4} \\d{2}:\\d{2}:\\d{2} GMT$","type":"string","example":"Thu, 15 Aug 2024 09:48:17 GMT"}},"Cache-Control":{"description":"Directives for caching mechanisms in responses","schema":{"type":"string","example":"private, no-cache, no-store, max-age=0, must-revalidate"}},"TrackingID":{"description":"A unique tracking ID for this request","schema":{"type":"string","example":"23e3c120"}}},"content":{"*/*":{"schema":{"required":["code","message"],"type":"object","properties":{"code":{"type":"integer","format":"int32","description":"A machine-readable code identifying the error type","example":200},"message":{"type":"string","description":"A human-readable message providing more details about the error","example":"Internal server error has occurred"},"fieldValidationErrors":{"type":"array","description":"An array of field validation errors","items":{"description":"Field validation error object","type":"object","properties":{"field":{"type":"string","description":"The name of the field that has been validated","example":"baudRate"},"message":{"type":"string","description":"A human-readable message providing more details about the error","example":"Not valid number"}},"$$ref":"#/components/schemas/FieldValidationDTO"},"example":[{"field":"baudRate","message":"Not valid number"}]},"timestamp":{"type":"string","format":"date-time","description":"The timestamp in ISO format","example":"2024-09-11T09:55:23.213Z"}},"description":"ErrorInfoDTO object","$$ref":"#/components/schemas/ErrorInfoDTO"},"example":{"code":400,"error":"Bad Request","message":"JSON parse error","path":"/api/v1/networks/{networkId}/bom"}}}},"401":{"description":"Unauthorized","headers":{"Date":{"description":"The date and time when the response was generated","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \\d{1,2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \\d{4} \\d{2}:\\d{2}:\\d{2} GMT$","type":"string","example":"Thu, 15 Aug 2024 09:48:17 GMT"}},"Cache-Control":{"description":"Directives for caching mechanisms in responses","schema":{"type":"string","example":"private, no-cache, no-store, max-age=0, must-revalidate"}},"TrackingID":{"description":"A unique tracking ID for this request","schema":{"type":"string","example":"23e3c120"}}},"content":{"*/*":{"schema":{"required":["code","message"],"type":"object","properties":{"code":{"type":"integer","format":"int32","description":"A machine-readable code identifying the error type","example":200},"message":{"type":"string","description":"A human-readable message providing more details about the error","example":"Internal server error has occurred"},"fieldValidationErrors":{"type":"array","description":"An array of field validation errors","items":{"description":"Field validation error object","type":"object","properties":{"field":{"type":"string","description":"The name of the field that has been validated","example":"baudRate"},"message":{"type":"string","description":"A human-readable message providing more details about the error","example":"Not valid number"}},"$$ref":"#/components/schemas/FieldValidationDTO"},"example":[{"field":"baudRate","message":"Not valid number"}]},"timestamp":{"type":"string","format":"date-time","description":"The timestamp in ISO format","example":"2024-09-11T09:55:23.213Z"}},"description":"ErrorInfoDTO object","$$ref":"#/components/schemas/ErrorInfoDTO"},"example":{"code":401,"error":"Unauthorized","message":"Authentication is required and has failed or has not yet been provided.","path":"/api/v1/networks/{networkId}/bom"}}}},"403":{"description":"Forbidden","headers":{"Date":{"description":"The date and time when the response was generated","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \\d{1,2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \\d{4} \\d{2}:\\d{2}:\\d{2} GMT$","type":"string","example":"Thu, 15 Aug 2024 09:48:17 GMT"}},"Cache-Control":{"description":"Directives for caching mechanisms in responses","schema":{"type":"string","example":"private, no-cache, no-store, max-age=0, must-revalidate"}},"TrackingID":{"description":"A unique tracking ID for this request","schema":{"type":"string","example":"23e3c120"}}},"content":{"*/*":{"schema":{"required":["code","message"],"type":"object","properties":{"code":{"type":"integer","format":"int32","description":"A machine-readable code identifying the error type","example":200},"message":{"type":"string","description":"A human-readable message providing more details about the error","example":"Internal server error has occurred"},"fieldValidationErrors":{"type":"array","description":"An array of field validation errors","items":{"description":"Field validation error object","type":"object","properties":{"field":{"type":"string","description":"The name of the field that has been validated","example":"baudRate"},"message":{"type":"string","description":"A human-readable message providing more details about the error","example":"Not valid number"}},"$$ref":"#/components/schemas/FieldValidationDTO"},"example":[{"field":"baudRate","message":"Not valid number"}]},"timestamp":{"type":"string","format":"date-time","description":"The timestamp in ISO format","example":"2024-09-11T09:55:23.213Z"}},"description":"ErrorInfoDTO object","$$ref":"#/components/schemas/ErrorInfoDTO"},"example":{"code":403,"error":"Forbidden","message":"You are not authorized to access this operation.","path":"/api/v1/networks/{networkId}/bom"}}}},"500":{"description":"Internal Server Error","headers":{"Date":{"description":"The date and time when the response was generated","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \\d{1,2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \\d{4} \\d{2}:\\d{2}:\\d{2} GMT$","type":"string","example":"Thu, 15 Aug 2024 09:48:17 GMT"}},"Cache-Control":{"description":"Directives for caching mechanisms in responses","schema":{"type":"string","example":"private, no-cache, no-store, max-age=0, must-revalidate"}},"TrackingID":{"description":"A unique tracking ID for this request","schema":{"type":"string","example":"23e3c120"}}},"content":{"*/*":{"schema":{"required":["code","message"],"type":"object","properties":{"code":{"type":"integer","format":"int32","description":"A machine-readable code identifying the error type","example":200},"message":{"type":"string","description":"A human-readable message providing more details about the error","example":"Internal server error has occurred"},"fieldValidationErrors":{"type":"array","description":"An array of field validation errors","items":{"description":"Field validation error object","type":"object","properties":{"field":{"type":"string","description":"The name of the field that has been validated","example":"baudRate"},"message":{"type":"string","description":"A human-readable message providing more details about the error","example":"Not valid number"}},"$$ref":"#/components/schemas/FieldValidationDTO"},"example":[{"field":"baudRate","message":"Not valid number"}]},"timestamp":{"type":"string","format":"date-time","description":"The timestamp in ISO format","example":"2024-09-11T09:55:23.213Z"}},"description":"ErrorInfoDTO object","$$ref":"#/components/schemas/ErrorInfoDTO"},"example":{"timestamp":"2024-09-10T14:21:02.790+00:00","code":500,"error":"Internal Server Error","message":"No message available","path":"/api/v1/networks/{networkId}/bom"}}}}},"security":[{"bearerAuth":[]}],"__originalOperationId":"getNetworkBomPage","method":"get","path":"/api/v1/networks/{networkId}/bom"}}