{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"69ad2b4a-f840-4488-a587-de7bb385d137","name":"OSPInsight API - 9.23","description":"## Overview\n\nThe OSPInsight API makes it easy for you to pull unique identifiers of your data out of OSPInsight and integrate these unique identifiers with other systems that hold your network data.\n\n## Getting Started\n\nTo start using the API you will need to update to OSPInsight Web 9.3 or laterwith the Integrations Add-on enabled. To retrieve an API Token, navigate to `Home`, click `Integrations`, and then copy the API Token _{apiToken}_ and use it in your GET Token request. The Token request will return an Access Token _{accessToken}_ you can use in the rest of your requests.\n\n## Notes and Documentation\n\nA few notes using the API and understanding the documentation.\n\n- Hostname _{hostname}_- Hostname is dependent on how your OSPInsight Web was configured and installed. It will most likely be in the format `https://[domain]/[Web9 or OSPInsightWeb9]`.\n    \n    - Examples of Web9 hostnames:\n        \n        - `https://example.com/Web9`\n            \n        - `https://198.51.100.250/Web9`\n            \n        - `https://example.com/OSPInsightWeb9`\n            \n- API Token _{apiToken}_ - The API token is available in OSPInsight Home via the Integrations Application. This is available from OSPInsight Web 9.3+.\n    \n- Access Token _{accessToken}_ - The Access token is retrieved from the initial Token call and is used for all the other requests.\n    \n- Pagination _{pageNumber}_ - Requests that retrieve a collection of objects will return a single page for each call. By default a call will return the first page. To retrieve the next page, set the query parameter page to the next iteration.\n    \n- GUIDs - We opted to use GUIDs for request keys instead of the object's primary key. The core reason for this is to provide a level of protection for your data. We don't want to make it trivial to guess another object by incrementing the primary key.\n    \n\n## Query Parameters\n\nMany of the calls in the API have a variety of parameters that can be used. Depending on the call, most of these are optional.\n\nWhen an optional parameter is not used, a default value for that parameter will be used. The following are most of the parameters that are found in the API, their usage, default values, and if those defaults are able to be changed (for use with on-prem installs).\n\n## Parameter: _page_\n\n#### Scope: Pagination\n\nRequest the page of the collection to be retrieved.\n\n`Page` is not used in individual entity requests.\n\n#### Details\n\n- Reference: _{pageNumber}_\n    \n- Default Value: `1`\n    \n- Settings Option: Default value is not editable\n    \n\n| Parameter | datatype | required/optional | Usage |\n| --- | --- | --- | --- |\n| page | number | optional | /buildings?page=3 |\n\n## Parameter: _size_\n\n#### Scope: Pagination\n\nRequest the max number of items return per page of the collection retrieved.\n\n`Size` is not used in individual entity requests.\n\n#### Details\n\n- Reference: _{pageSize}_\n    \n- Default Value: `20`\n    \n- Max value: `50`\n    \n- Settings Option: _OpenApiDefaultPageSize_ and _OpenApiMaxPageSize_\n    \n\n| Parameter | datatype | required/optional | Usage |\n| --- | --- | --- | --- |\n| size | number | optional | /buildings?page=3&size=10 |\n\n## Parameter: _name_\n\n#### Scope: Pagination\n\nFilters the collection by the `Name` field.\n\n`Name` is not used in individual entity requests.\n\n#### Details\n\n- Reference: _{name}_\n    \n- Default Value: No default value for `Name`\n    \n- Settings Option: Default value is not editable\n    \n\n| Parameter | datatype | required/optional | Usage |\n| --- | --- | --- | --- |\n| name | string | optional | /buildings?name=hub |\n\n## Parameter: _filter_\n\n#### Scope: Pagination\n\nRequired usage with `Name` parameter.\n\nSpecifies the type of filtering to use with the `Name` parameter.\n\n`NameFilter` is not used in individual entity requests.\n\n#### Details\n\n- Reference: _{nameFilter}_\n    \n- Default Value: `contains`\n    \n- Settings Option: Default value is not editable\n    \n\n#### Available Filters\n\n- `contains` - _(default)_ `Name` is found within the field\n    \n- `exact` - `Name` must match the field exact\n    \n- `startsWith` - `Name` is at the start of the field\n    \n- `endsWith` - `Name` is at the end of the field\n    \n\n| Parameter | datatype | required/optional | Usage |\n| --- | --- | --- | --- |\n| filter | string | optional | /buildings?name=hub&filter=startsWith |\n\n## Parameter: _startCreateTime_\n\n#### Scope: Pagination\n\nFilters the collection by the `CreateTime` field found after a specified date. The specified date uses the [ISO8601](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#ISO8601) date format.\n\nCan be used with `EndCreateTime` parameter to filter by a date range.\n\n`StartCreateTime` is not used in individual entity requests.\n\n#### Details\n\n- Reference: _{startCreateTime}_\n    \n- Default Value: No default value for `StartCreateTime`\n    \n- Settings Option: Default value is not editable\n    \n\n| Parameter | datatype | required/optional | Usage |\n| --- | --- | --- | --- |\n| startCreateTime | dateTime | optional | /buildings?startCreateTime=2021-05-01 |\n|  |  |  | /buildings?startCreateTime=2021-05-01T15:30:00Z |\n|  |  |  | /buildings?startCreateTime=2021-05-01&endCreateTime=2021-05-30 |\n\n## Parameter: _endCreateTime_\n\n#### Scope: Pagination\n\nFilters the collection by the `CreateTime` field found before a specified date. The specified date uses the [ISO8601](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#ISO8601) date format.\n\nCan be used with `StartCreateTime` parameter to filter by a date range.\n\n`EndCreateTime` is not used in individual entity requests.\n\n#### Details\n\n- Reference: _{endCreateTime}_\n    \n- Default Value: No default value for `EndCreateTime`\n    \n- Settings Option: Default value is not editable\n    \n\n| Parameter | datatype | required/optional | Usage |\n| --- | --- | --- | --- |\n| endCreateTime | dateTime | optional | /buildings?endCreateTime=2021-05-30 |\n|  |  |  | /buildings?endCreateTime=2021-05-30T23:59:59Z |\n|  |  |  | /buildings?startCreateTime=2021-05-01&endCreateTime=2021-05-30 |\n\n## Parameter: _startUpdateTime_\n\n#### Scope: Pagination\n\nFilters the collection by the `UpdateTime` field found after a specified date. The specified date uses the [ISO8601](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#ISO8601) date format.\n\nCan be used with `EndUpdateTime` parameter to filter by a date range.\n\n`StartUpdateTime` is not used in individual entity requests.\n\n#### Details\n\n- Reference: _{startUpdateTime}_\n    \n- Default Value: No default value for `StartUpdateTime`\n    \n- Settings Option: Default value is not editable\n    \n\n| Parameter | datatype | required/optional | Usage |\n| --- | --- | --- | --- |\n| startUpdateTime | dateTime | optional | /buildings?startUpdateTime=2021-05-01 |\n|  |  |  | /buildings?startUpdateTime=2021-05-01T15:30:00Z |\n|  |  |  | /buildings?startUpdateTime=2021-05-01&endUpdateTime=2021-05-30 |\n\n## Parameter: _endUpdateTime_\n\n#### Scope: Pagination\n\nFilters the collection by the `UpdateTime` field found before a specified date. The specified date uses the [ISO8601](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#ISO8601) date format.\n\nCan be used with `StartUpdateTime` parameter to filter by a date range.\n\n`EndUpdateTime` is not used in individual entity requests.\n\n#### Details\n\n- Reference: _{endUpdateTime}_\n    \n- Default Value: No default value for `EndUpdateTime`\n    \n- Settings Option: Default value is not editable\n    \n\n| Parameter | datatype | required/optional | Usage |\n| --- | --- | --- | --- |\n| endUpdateTime | dateTime | optional | /buildings?endUpdateTime=2021-05-30 |\n|  |  |  | /buildings?endUpdateTime=2021-05-30T23:59:59Z |\n|  |  |  | /buildings?startUpdateTime=2021-05-01&endUpdateTime=2021-05-30 |\n\n## Parameter: _includeGeo_\n\n#### Scope: Data\n\nRequest that `geometry` data is included in the collection items.\n\n#### Details\n\n- Reference: _{includeGeo}_\n    \n- Default Value: `True`\n    \n- Settings Option: Default value is not editable\n    \n\n| Parameter | datatype | required/optional | Usage |\n| --- | --- | --- | --- |\n| includeGeo | boolean | optional | /buildings?includeGeo=false |\n\n## Parameter: _srid_\n\n#### Scope: Data\n\nRequest that `geometry` data is to be returned in a specified coordinate system.\n\nThe requested coordinate system needs to be added to Web9's known coordinate systems for this to work.\n\n#### Details\n\n- Reference: _{srid}_\n    \n- Default Value: `4326` ([WGS 84](https://epsg.io/4326))\n    \n- Settings Option: _OpenApiDefaultSrid_\n    \n\n| Parameter | datatype | required/optional | Usage |\n| --- | --- | --- | --- |\n| srid | number | optional | /buildings?srid=3395 |\n\n## Parameter: _includeBBox_\n\n#### Scope: Data\n\nRequest that `geometry` data also includes a bounding box.\n\n#### Details\n\n- Reference: _{includeBBox}_\n    \n- Default Value: `True`\n    \n- Settings Option: Default value is not editable\n    \n\n| Parameter | datatype | required/optional | Usage |\n| --- | --- | --- | --- |\n| includeBBox | boolean | optional | /buildings?includeBBox=false |\n\n## Parameter: _geoConvert_\n\n#### Scope: Data\n\nRequest that `geometry` be returned as a specific Geometry shape.\n\n#### Details\n\n- Reference: _{geoConvert}_\n    \n- Default Value: `none`\n    \n- Settings Option: Default value is not editable\n    \n\n#### Available Options\n\n- `none` - _(default)_ `Geometry` will be returned as stored.\n    \n- `toPoint` - `Geometry` will be returned as `Point`:\n    \n    - `Polygon` data will return their centroids as `Point`.\n        \n    - `Point` data will be returned as stored.\n        \n    - `Linestring` is not supported.\n        \n\n| Parameter | datatype | required/optional | Usage |\n| --- | --- | --- | --- |\n| geoConvert | string | optional | /buildings?geoConvert=toPoint |\n\n## Parameter: _include_\n\n#### Scope: Response Body\n\nRequest that the body request contains certain elements:\n\n- `data` - _(default)_ Returns the data collection\n    \n- `paging` - _(default)_ Returns paging information\n    \n\n#### Details\n\n- Reference: _{responseInclude}_\n    \n- Default Value: `data,paging`\n    \n- Settings Option: Default value is not editable\n    \n\n| Parameter | datatype | required/optional | Usage |\n| --- | --- | --- | --- |\n| include | string | optional | /buildings?include=data |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"12104879","team":659824,"collectionId":"69ad2b4a-f840-4488-a587-de7bb385d137","publishedId":"2sA3dsnZgx","public":true,"publicUrl":"https://api.ospinsight.com","privateUrl":"https://go.postman.co/documentation/12104879-69ad2b4a-f840-4488-a587-de7bb385d137","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.11.4","publishDate":"2024-06-27T16:59:36.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Web 9 Api - Doc - 9.23","id":"fcb3a0d9-9425-4251-ae67-2faafcc13dff","owner":"12104879","values":[{"key":"hostname","value":"http://localhost/Web9","enabled":true},{"key":"Bearer Token","value":"3bab0240-6949-48b2-902a-58d0d4e511ba","enabled":true},{"key":"accessToken","value":"e5f3e039-e767-4244-8914-1708a9f74c99","enabled":true},{"key":"networkGuid","value":"c1cb3265-b13e-466a-bd30-e351226ceee3","enabled":true},{"key":"apiToken","value":"c6a87e25-be1a-44b0-9846-dcfc3ce4b598","enabled":true},{"key":"accessPointGuid","value":"fdb892ba-0347-e711-9acd-782bcb19c20c","enabled":true},{"key":"alarmGuid","value":"d92648de-974b-4c47-b9aa-3c1246659719","enabled":true,"type":"any"},{"key":"buildingGuid","value":"0e6f157b-0047-e711-9acd-782bcb19c20c","enabled":true},{"key":"customerGuid","value":"3f26a698-7ad2-40bd-a487-b6c2f7942a5f","enabled":true,"type":"any"},{"key":"deviceGuid","value":"7ffff302-25a2-e711-9663-f01faff1b24b","enabled":true,"type":"any"},{"key":"ductbankGuid","value":"ee00aa8f-4555-e711-81f1-782bcb19c20c","enabled":true},{"key":"enclosureGuid","value":"d0301ab2-0347-e711-9acd-782bcb19c20c","enabled":true},{"key":"equipmentGuid","value":"f829718c-2c4a-e711-9acd-782bcb19c20c","enabled":true,"type":"any"},{"key":"poleGuid","value":"38330c23-cd4a-e711-bb9e-782bcb19c20c","enabled":true},{"key":"portGuid","value":"8441f926-0147-e711-9acd-782bcb19c20c","enabled":true,"type":"default"},{"key":"routeGuid","value":"062467e3-ce4a-e711-bb9e-782bcb19c20c","enabled":true},{"key":"slackloopGuid","value":"62efafd0-e252-e711-81f1-782bcb19c20c","enabled":true},{"key":"spanGuid","value":"5d10e9af-5e48-4187-8420-f37b456476ce","enabled":true},{"key":"strandGuid","value":"c8afa30a-1446-e711-9acd-782bcb19c20c","enabled":true,"type":"default"},{"key":"terminationPointGuid","value":"16a11020-0147-e711-9acd-782bcb19c20c","enabled":true},{"key":"srid","value":"4326","enabled":true},{"key":"pageNumber","value":"1","enabled":true},{"key":"pageSize","value":"20","enabled":true},{"key":"navigationLinks","value":"true","enabled":true},{"key":"name","value":"","enabled":true},{"key":"nameFilter","value":"contains","enabled":true},{"key":"startCreateTime","value":"2021-05-01T16:20:00Z","enabled":true},{"key":"endCreateTime","value":"2021-05-30T23:59:00Z","enabled":true},{"key":"startUpdateTime","value":"2021-05-01T16:20:00Z","enabled":true},{"key":"endUpdateTime","value":"2021-05-30T23:59:00Z","enabled":true},{"key":"includeGeo","value":"true","enabled":true},{"key":"includeBBox","value":"true","enabled":true},{"key":"geoConvert","value":"toPoint","enabled":true},{"key":"responseInclude","value":"data,paging","enabled":true},{"key":"faultDistance","value":"13510","enabled":true},{"key":"units","value":"m","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/3c0200230a7decf01d38df414f0a2d49d858d54868a11554ed106378687fde6f","favicon":"https://res.cloudinary.com/postman/image/upload/v1580341928/team/qljiutm4u7yyfyvmwoqy.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Web 9 Api - Doc - 9.23","value":"12104879-fcb3a0d9-9425-4251-ae67-2faafcc13dff"}],"canonicalUrl":"https://api.ospinsight.com/view/metadata/2sA3dsnZgx"}