The GSS ServiceBastion provides a high-level API around the TFC DeepLaser client. By design, DeepLaser is a low-level conduit to TFC Device Connect services, and as such, leaves a lot of work to the instrument team. The GSS Service Client provides operations for:
\nContact Support:\n Name: GSS Software\n Email: gsssoftware@thermofisher.com
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"14301234","collectionId":"0491afd3-d8d1-4b41-b785-85bc1e090ce0","publishedId":"Tzedh4gM","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-06-25T17:45:27.000Z"},"item":[{"name":"service Authentication","item":[{"name":"Get sync code","id":"30ab997f-7a6f-4d03-ba0a-9b8225c2fbfa","request":{"method":"GET","header":[],"url":"http://localhost:6555//serviceAuthentication","description":"The algorithm for generating the one-time passcodes used to access the service GUI\nrequire two shared secrets.
\nIf the counter on cloud service responsible for generating passcodes gets out of\nsync from the instrument, the synchronization code facilitates the re-synchronization\nof the instrument and the cloud service passcodes.
\n","urlObject":{"path":["serviceAuthentication"],"host":["http://localhost:6555/"],"query":[],"variable":[]}},"response":[{"id":"3f5053a4-f023-45e1-bc7d-79fda2574244","name":"response","originalRequest":{"method":"GET","header":[],"url":"http://localhost:6555//serviceAuthentication"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"syncCode\": \"61831445\"\n}"},{"id":"781122a0-9c86-4d2c-88b6-987343264d6f","name":"Invalid request","originalRequest":{"method":"GET","header":[],"url":"http://localhost:6555//serviceAuthentication"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"5a52dd5e-a856-4fc7-92a9-4c3858f27bd7","name":"Internal Server Error\nIn most cases the request was understood, but the GSS_DEVICE_SERIAL or GSS_DEVICE_MODEL have not been set in the config.json file","originalRequest":{"method":"GET","header":[],"url":"http://localhost:6555//serviceAuthentication"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"30ab997f-7a6f-4d03-ba0a-9b8225c2fbfa"},{"name":"Check passcode","id":"4eb15e4f-67be-45d7-9c85-cd73aa5cee9f","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{}"},"url":"http://localhost:6555//serviceAuthentication","description":"Check the user-entered passcode according the standard algorithm and current date-time.
\n","urlObject":{"path":["serviceAuthentication"],"host":["http://localhost:6555/"],"query":[],"variable":[]}},"response":[{"id":"e07cbcd8-d545-418c-974e-15080ef9682c","name":"The login attempt is validated and the user should be granted access.","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{}"},"url":"http://localhost:6555//serviceAuthentication"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"c7552f37-afe9-4e93-a782-ea468aaee122","name":"Invalid request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{}"},"url":"http://localhost:6555//serviceAuthentication"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"e6766edb-c50b-4d78-ac20-5bc360e75469","name":"The response is not valid and user should not be granted access.","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{}"},"url":"http://localhost:6555//serviceAuthentication"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"authorized\": false\n}"},{"id":"1f40676c-111f-4973-899c-dcd0649ce631","name":"Internal Server Error\nIn most cases the request was understood, but the GSS_DEVICE_SERIAL or GSS_DEVICE_MODEL have not been set in the config.json file","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{}"},"url":"http://localhost:6555//serviceAuthentication"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"4eb15e4f-67be-45d7-9c85-cd73aa5cee9f"}],"id":"8270e66c-de7b-44d9-a002-94c22cc26b5f","_postman_id":"8270e66c-de7b-44d9-a002-94c22cc26b5f","description":""},{"name":"management/queue/{job Id}","item":[{"name":"Get status of long-running job.","id":"b678e53d-39c1-43a9-aef2-0deb5345f2a2","request":{"method":"GET","header":[],"url":"http://localhost:6555//management/queue/:jobId","description":"Some operations, like opening a SmartHelp ticket, happen asynchronously. These operations return HTTP status code 203 (accepted) which indicates the operation has been queued. When this happens, the Location header is returned. The path indicated in the Location header can be used to query the status of the job if necessary.
(Required) The jobId of the long-running task.
\n","type":"text/plain"},"type":"any","value":"69242525","key":"jobId"}]}},"response":[{"id":"961ca077-8bc6-47cf-9079-35b4dc9d36a6","name":"The job was found and status information is provided in the response body.","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://localhost:6555//management/queue/:jobId","host":["http://localhost:6555/"],"path":["management","queue",":jobId"],"variable":[{"key":"jobId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"33fa8a74-a2d2-47c9-9536-c47139939e91","name":"Job was not found.","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://localhost:6555//management/queue/:jobId","host":["http://localhost:6555/"],"path":["management","queue",":jobId"],"variable":[{"key":"jobId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"b678e53d-39c1-43a9-aef2-0deb5345f2a2"},{"name":"Cancel long-running job.","id":"0479da97-f208-4adb-ac12-66da965a2ede","request":{"method":"DELETE","header":[],"url":"http://localhost:6555//management/queue/:jobId","description":"Some operations, like opening a SmartHelp ticket, happen asynchronously. These operations return HTTP status code 203 (accepted) which indicates the operation has been queued. When this happens, the Location header is returned. The path indicated in the Location header can be used to cancel it if necessary.
(Required) The jobId of the long-running task.
\n","type":"text/plain"},"type":"any","value":"69242525","key":"jobId"}]}},"response":[{"id":"89b6930e-2a77-4474-a4ce-5ecc936fceb5","name":"The job was canceled.","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"http://localhost:6555//management/queue/:jobId","host":["http://localhost:6555/"],"path":["management","queue",":jobId"],"variable":[{"key":"jobId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"0dc6bbd5-84cd-47f4-b1c3-0da2bbb7a1ea","name":"Job was not found.","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"http://localhost:6555//management/queue/:jobId","host":["http://localhost:6555/"],"path":["management","queue",":jobId"],"variable":[{"key":"jobId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"0479da97-f208-4adb-ac12-66da965a2ede"}],"id":"b1fac4f2-90ad-4bac-b311-5316678edb21","_postman_id":"b1fac4f2-90ad-4bac-b311-5316678edb21","description":""},{"name":"client","item":[{"name":"Get client status.","id":"354e6109-5f53-4843-9b8a-c1b751cbea3c","request":{"method":"GET","header":[],"url":"http://localhost:6555//client/status","urlObject":{"path":["client","status"],"host":["http://localhost:6555/"],"query":[],"variable":[]}},"response":[{"id":"5dcb6ce3-d91b-4dce-b8fd-97cac4df8b86","name":"The status has been returned.","originalRequest":{"method":"GET","header":[],"url":"http://localhost:6555//client/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"354e6109-5f53-4843-9b8a-c1b751cbea3c"},{"name":"Get client configuration.","id":"9378a82d-1807-486c-8b92-aedccb3ba138","request":{"method":"GET","header":[],"url":"http://localhost:6555//client/configuration","description":"Get the current configuration of the client.
\n","urlObject":{"path":["client","configuration"],"host":["http://localhost:6555/"],"query":[],"variable":[]}},"response":[{"id":"af13fd10-b715-4cce-9670-a9fd0f0f8cf1","name":"Current configuration of the client","originalRequest":{"method":"GET","header":[],"url":"http://localhost:6555//client/configuration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"9378a82d-1807-486c-8b92-aedccb3ba138"}],"id":"5c0d7c82-57db-45c1-b014-88430a6566d7","_postman_id":"5c0d7c82-57db-45c1-b014-88430a6566d7","description":""},{"name":"Uploads files to the TFS cloud and provides short codes to access them.","id":"aa3d3741-ffc4-44c9-b748-0c9bfb39de6b","request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[]},"url":"http://localhost:6555//uploadFiles","description":"Upload the attatched files. After a successful request, a 200 code is returned indicating the job has been queued. The Location header in the response has the URL where job progress can be checked or the job can be canceled.
In order to receive a notification when the files are sucessfully uploade the callbackUrl parameter has to be provided.
Open a Service ticket with attached files. After a successful request, a 203 code is returned indicating the job has been queued. The Location header in the response has the URL where job progress can be checked or the job can be canceled.
In order to receive a notification of the successful creation of a service ticket, including the actual id of the ticket, the callbackUrl parameter has to be provided.
Instruments should send telemetry information record relevant sensor readings or other internal parameters. Telemetry data should be quantitative (eg current temperature, pressure, voltage), categorical data may be acceptable as well, (eg “idle”, “running”, “maintenance-pending”).
\nThe schema of the data is inferred from the instrument type and supplied schemaVer. The schema will be retrieved and used to validate the message.
Although the GSS service data repository allows for structured telemetry data, the Device Connect telemetry services do not. To maintain compatibility the data will be automatically flattened. For example:
\n{\n \"timestamp\": \"2019-11-12T05:14:25.114Z\",\n \"data\": {\n \"temperature\": 33,\n \"reservoir_level\": 80,\n \"fan_front\": {\n \"dutyCycle\": .43,\n \"speed\": 1023\n }\n}\nwould be automatically flattened by adding __ between parent objects and child properties:
{\n \"timestamp\": \"2019-11-12T05:14:25.114Z\",\n \"temperature\": 33,\n \"reservoir_level\": 80,\n \"fan_front__dutyCycle\": .43,\n \"fan_front__speed\": 1023\n }\n}\nwhen submitted to DeviceConnect.
\n","urlObject":{"path":["telemetry"],"host":["http://localhost:6555/"],"query":[],"variable":[]}},"response":[{"id":"a6e206a7-8f70-4be8-88dd-9cb9137ef421","name":"Telemetry data was accepted.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{}"},"url":"http://localhost:6555//telemetry"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"64b52940-459c-46a8-bedd-46462a8196af","name":"Invalid request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{}"},"url":"http://localhost:6555//telemetry"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"a6e6bc78-4755-4782-8e5d-bb03edb44db0","name":"Problem connecting to DeepLaser client.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{}"},"url":"http://localhost:6555//telemetry"},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f944e196-abb9-46f6-8e2e-369f92b630e2"},{"name":"Updates instrument status","id":"6591bfa6-0cfe-4456-81a0-28c115ceef30","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{}"},"url":"http://localhost:6555//status","description":"Status is information about the current state of the instrument. State information does not change frequently, examples of state include SYSTEM software version, IVD/DX mode, and identity of loaded consumables. Status data is typically categorical, but examples of quantitative status data include battery level and consumables levels.
\nStatus information should be limited to “independent” variables relating to instrument configuration rather than variables that vary during the normal operation of the instrument.
\n","urlObject":{"path":["status"],"host":["http://localhost:6555/"],"query":[],"variable":[]}},"response":[{"id":"887134cf-918a-4626-b3ff-22873bbd0d18","name":"Status data was accepted.","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{}"},"url":"http://localhost:6555//status"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"6c76d6ad-9c8e-4f35-ada7-e9546b44ca91","name":"Invalid request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{}"},"url":"http://localhost:6555//status"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"77f5e4ac-68c1-48ba-930f-e26929af2285","name":"Unable to contact DeepLaser.","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{}"},"url":"http://localhost:6555//status"},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"6591bfa6-0cfe-4456-81a0-28c115ceef30"},{"name":"Sends event information","id":"f522fd7f-9ec7-44d5-82a7-d3889d09b0bc","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{}"},"url":"http://localhost:6555//event","description":"Instruments should send an event to make the occurrence of a service-relevant event, such as an error or the completion of a preventative maintenance procedure.
\n","urlObject":{"path":["event"],"host":["http://localhost:6555/"],"query":[],"variable":[]}},"response":[{"id":"7f115a98-2e8e-4797-93fe-b170e8b13ae5","name":"The event was accepted.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{}"},"url":"http://localhost:6555//event"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"e1cabbd7-8a13-4e3c-b51d-08f7739ed3a8","name":"Invalid request.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{}"},"url":"http://localhost:6555//event"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"3051ac5e-2a85-44b5-ba9c-51f0fb18c298","name":"Unable to connect to DeepLaser","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{}"},"url":"http://localhost:6555//event"},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f522fd7f-9ec7-44d5-82a7-d3889d09b0bc"},{"name":"Sends high-resolution episodic data","id":"9cb10052-f5c0-461c-8fc2-f03c9f56d297","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{}"},"url":"http://localhost:6555//episode","description":"Episodic data is used when sending data on high-speed transients that are too fast to be captured in the regular telemetry data.
\n","urlObject":{"path":["episode"],"host":["http://localhost:6555/"],"query":[],"variable":[]}},"response":[{"id":"24fd710d-c4a3-4d3c-8266-f558da74a234","name":"The high-resolution data was accepted.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{}"},"url":"http://localhost:6555//episode"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"41149b65-b2cb-4205-bdd2-82637bd994b1","name":"Invalid request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{}"},"url":"http://localhost:6555//episode"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"aa9dbfed-73cd-4a5e-9ed3-d87a547c9e14","name":"Unable to connect to DeepLaser","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{}"},"url":"http://localhost:6555//episode"},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"9cb10052-f5c0-461c-8fc2-f03c9f56d297"},{"name":"swaggerui","id":"ea8ea47a-0527-4572-a469-14760de37476","request":{"method":"GET","header":[],"url":"http://localhost:6555//api-docs","description":"Describes the ServiceBastion endpoints.
\n","urlObject":{"path":["api-docs"],"host":["http://localhost:6555/"],"query":[],"variable":[]}},"response":[],"_postman_id":"ea8ea47a-0527-4572-a469-14760de37476"}],"variable":[{"id":"ac23eae5-6048-4eed-b49a-a8989b0dd143","key":"baseUrl","value":"http://localhost:6555/","type":"string"}]}