{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"d383c8ac-a17e-49e5-af11-efc14dde9414","name":"OpenPath SaaS API","description":"# Server Resources\r\n\r\nA server resource is a collection of available functions and objects associated with your organization. If authenticated your application can make calls to these resources over SSL. Each server resource is contained within the result of an OpenPath envelope as described in the next section.\r\n\r\n# HTTP Verbs and CRUD\r\n\r\nThe HTTP Verbs are how the HTTP requests are made (e.g. POST, GET, PATCH, PUT and DELETE). These verbs determine how you interact with the resource. The follow is the list of HTTP Verbs OpenPath uses and how they function.\r\n\r\n|HTTP Verb|CRUD Operation|Explanation\r\n|--|--|--|\r\n|POST|Create|Creates a new item.|\r\n|GET|Read|Reads an item.|\r\n|PATCH|Update|Updates parts of an item.|\r\n|DELETE|Delete|Deletes an item.|\r\n|PUT|Replaces|Replaces an item using the same ID.|\r\n\r\n# HTTPS Response Codes\r\n\r\nThe SaaS API will return a standard HTTP response code along with the status code wrapped in the JSON envelope for any request made to the system. The following is a list of the response codes the API may generate.\r\n\r\n|Code|Message|Description|\r\n|--|--|--|\r\n|200|Ok|Request executed successfully.|\r\n|201|Created|When an item was successfully created, updated or replaced and the created item URI will be returned in the header.|\r\n|400|Bad Request|The request could not be understood by the server due to malformed syntax.|\r\n|401|Unauthorize|The request requires user authentication. The response must include a Authenticate header field with an OpenApth API Key.|\r\n|404|Not Found|The server has not found anything matching the Request-URI.|\r\n|500|Internal Server Error|The server encountered an unexpected condition which prevented it from fulfilling the request.|\r\n\r\n# Envelopes\r\n\r\nEnvelopes return a standardize response from all server resources and inside the result of the envelope is the actual data from the server resource. Each envelope contains information about the returned data record counts, the application, the endpoint, the http status and any errors they may have occurred.\r\n\r\nDepending on the requested content type an envelope will return either a JSON or XML output in the body of the response. Regardless of any errors the server resource will alway return and envelope. If the request was successful, then within the result section of the envelope will be the serialized data of the request.\r\n\r\nThe envelope also has standard actions which work with all resources, which can help limit the amount of requested data by using pages and page sizes.\r\n\r\n# Response\r\n```json\r\n{\r\n    \"organization\": \"OpenPath, Incorporated\",\r\n    \"web_site\": \"https://openpath.io\",\r\n    \"phone_number\": \"+1 (844) PATH-24/7\",\r\n    \"email\": \"support@openpath.io\",\r\n    \"application\": \"OpenPath SaaS API\",\r\n    \"version\": \"3.xx.xxxx\",\r\n    \"copyright\": \"Copyright ©2018 OpenPath, Inc.\",\r\n    \"name\": \"Example-Envelope\",\r\n    \"description\": \"This is an example envelope response from the OpenPath SaaS API. Unauthorized access is strictly prohibited.\",\r\n    \"result\": [\r\n        {\r\n            \"id\": 1,\r\n            \"name\": \"Teapot\",\r\n            \"description\": \"I'm a teapot\"\r\n        },\r\n        {\r\n            \"id\": 2,\r\n            \"name\": \"Spout\",\r\n            \"description\": \"I'm a spout\"\r\n        },\r\n        {\r\n            \"id\": 3,\r\n            \"name\": \"Short\",\r\n            \"description\": \"I'm short\"\r\n        },\r\n        {\r\n            \"id\": 4,\r\n            \"name\": \"Stout\",\r\n            \"description\": \"I'm stout\"\r\n        }\r\n    ],\r\n    \"paging\": {\r\n        \"count\": 4,\r\n        \"page\": 1,\r\n        \"size\": 4\r\n    },\r\n    \"filter\": {\r\n        \"search\": [\r\n            {\r\n                \"key\": \"id\",\r\n                \"method\": \"IsGreaterThan\",\r\n                \"value\": \"5\"\r\n            },\r\n            {\r\n                \"key\": \"description\",\r\n                \"method\": \"Contains\",\r\n                \"value\": \"I'm\"\r\n            }\r\n        ],\r\n        \"sort_by\": \"id\",\r\n        \"sort_ascending\": true\r\n    },\r\n    \"status\": 200,\r\n    \"status_message\": \"Ok\",\r\n    \"errors\": [\r\n        {\r\n            \"source\": \"Validation\",\r\n            \"message\": \"ID must be less than or equal to 100\"\r\n        },\r\n        {\r\n            \"source\": \"Database\",\r\n            \"message\": \"The database is currently unavailable\"\r\n        }\r\n    ]\r\n}\r\n```\r\n\r\n# Envelope Item\r\n\r\n|Key|Description|\r\n|--|--|\r\n|**Organization**|This is the organization that owns the API.|\r\n|**Web Site**|The URL of the owner of the API.|\r\n|**Phone Number**|The phone number of the owner of the API.|\r\n|**Email**|The email adddress of the owner of the API.|\r\n|**Application**|This is the name of the API Resource available.|\r\n|**Version**|This is the current version of the API. The format is *[Version]*.*[Feature]*.*[Build]*.|\r\n|**Copyright**|This is the copyright date and information for the API Resource.|\r\n|**Name**|This is the name of the end-point.|\r\n|**Description**|A description of what this end-point is and does.|\r\n|**Result**|The result data from the end-point which can be a single object or an array.|\r\n|**Paging**|[See Paging Item](#Paging Item).|\r\n|**Filter**|[See Filter Item](#Filter Item).|\r\n|**Status**|The HTTP response status code.|\r\n|**Status Message**|The HTTP response status code text.|\r\n|**Errors**|An array of Error Items [See Error Item](#Error Item).|\r\n\r\n# Paging Item\r\n\r\n|Key|Description|\r\n|--|--|\r\n|**Count**|The total number of items.|\r\n|**Page**|The page number of the returned items.|\r\n|**Size**|The number or items returned per page.|\r\n\r\n# Filter Item\r\n\r\n|Key|Description|\r\n|--|--|\r\n|**Search**|An array of Search Items [See Search Item](#Search Item).|\r\n|**Sort By**|The key the items are sorted on.|\r\n|**Sort Assending**|Which direction to sort the sort by key.|\r\n\r\n# Search Item\r\n\r\n|Key|Description|\r\n|--|--|\r\n|**Key**|Which key to apply this search filter too.|\r\n|**Method**|The search method applied to the key and value searching for.|\r\n|**Value**|The value of they key to apply the search method too.|\r\n\r\n## Search Item Methods\r\n\r\n- Equals\r\n- DoesNotEqual\r\n- IsGreaterThan\r\n- IsGreaterThanOrEqual\r\n- IsLessThan\r\n- IsLessThanOrEqual\r\n- StartsWith\r\n- EndsWith\r\n- Contains\r\n- MatchesRegex\r\n- DoesNotMatchRegex\r\n\r\n# Error Item\r\n\r\n|Key|Description|\r\n|--|--|\r\n|**Source**|Where the error was generated.|\r\n|**Message**|What the error message is about.|","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"609744","team":78295,"collectionId":"d383c8ac-a17e-49e5-af11-efc14dde9414","publishedId":"RW1eky1F","public":true,"publicUrl":"https://api-saas-docs.openpath.io","privateUrl":"https://go.postman.co/documentation/609744-d383c8ac-a17e-49e5-af11-efc14dde9414","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"3F51B5"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2018-05-22T22:28:33.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"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/4635673738dea0ac2202271ce2fc0861030bacd6381ac746ee7c21832ca41bbf","favicon":"https://openpath.io/favicon.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"}],"canonicalUrl":"https://api-saas-docs.openpath.io/view/metadata/RW1eky1F"}