{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"89a1fc16-703b-48e8-a069-92bc719bda1e","name":"SapphireIMS API","description":"\"Sapphire\n\n

© COPYRIGHT Tecknodreams Software Consulting Pvt. Ltd.

\n\n

Information in this user guide, including URLs and other\nInternet Web site references, is subject to change without notice. Unless otherwise noted, the\ncompanies, organizations, products, domain names, e-mail addresses, logos, people, places, and\nevents depicted in examples herein are fictitious. No association with any real company,\norganization, product, domain name, e-mail address, logo, person, place, or event is intended or\nshould be inferred.\nComplying with all applicable copyright laws is the responsibility of the user. Without limiting the\nrights under copyright, no part of this user guide may be reproduced, stored in or introduced into a\nretrieval system, or transmitted in any form or by any means (electronic, mechanical,\nphotocopying, recording, or otherwise), or for any purpose, without the express written permission\nof Tecknodreams Software Consulting Pvt. Ltd.

\n\n\n

INTRODUCTION

\n\nSapphireIMS makes businesses agile through a modular and easy to implement suite of products, such as ITIL Service Desk, Enterprise Asset Management, Enterprise Service Management, Business Service Monitoring and Service Lifecycle Management. Our Healthcare Service Management solution is specifically designed for the needs of the healthcare industry.\n\n\n\n

What is the SapphireIMS REST API?

\n\n

The SapphireIMS REST API gives Partners and Customers a simple yet powerful way to interact with the SapphireIMS system and thereby integrate SapphireIMS with other applications in the ecosystem. Because it uses HTTP requests, responses, and standard data structures, the REST API is accessible from many programming languages and applications that use the most current web technologies.

\n\n\n

What is Postman?

\n\n

Postman is a tool which helps you build, test, and document APIs faster. Postman helps to create API clients in different languages. Download and Install the Postman application. Please refer the link for the Postman document here! We have created a bundle that includes all of the commonly used API calls with the REST API. This is the first step in getting started with the SapphireIMS REST API.

\n\n

Import Configuration into Postman

\n\n

You can import the configuration into Postman by clicking on the “Run In Postman” button located in the header of this document.

\n\n

Setup your Environment

\n\n

Now we are almost ready to get started. The last step is to setup your environment. From the environment drop down in the upper right of the application, select “Manage Environments.” As shown in the screenshot, you need to add the environment variables shown below to test.

\n\n

key - Authentication Key, Get the key details from SapphireIMS Support

\n

token - Authentication token, Get the token details from SapphireIMS Support

\n

int-log-id a unique id for each request

\n

url - URL where the SapphireIMS application is deployed

\n\n

\"Enviornment

\n\n

SapphireIMS Error Codes :
\n\nSUCCESS, \"200\"
\nDUPLICATE_ENTITY, \"501\"
\nENTITY_DELETED, \"502\"
\nDUPLICATE_USER, \"404\"
\nUNAUTHORIZED, \"403\"
\nINVALID_LOGIN, \"405\"
\nUSER_INACTIVE, \"407\"
\nUSER_LOCKED, \"408\"
\nSESSION_EXPIRED, \"409\"
\nINVALID_INPUT, \"300\"
\nNO_SUCH_ENTITY, \"301\"
\nNO_RESULT_FOUND, \"302\"
\nSYS_ERROR, \"500\"
\nVALIDATION, \"303\"
\nTHIRD_PARTY_SERVER_NOT_REACHABLE, \"504\"
\nINVALID_TOKEN, \"1004\"
\nAUTOMATION_SERVER_DOWN, \"1005\"

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"5628215","team":281715,"collectionId":"89a1fc16-703b-48e8-a069-92bc719bda1e","publishedId":"RWgtTHPN","public":true,"publicUrl":"https://api.sapphireims.com","privateUrl":"https://go.postman.co/documentation/5628215-89a1fc16-703b-48e8-a069-92bc719bda1e","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2023-04-03T10:04:14.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/3708ea337f4e261c1efb13d7994064fc6dd3cc52f37b1add96a71ca5437d22fc","favicon":"https://sapphireims.com/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.sapphireims.com/view/metadata/RWgtTHPN"}