openapi: 3.0.1
info:
description: |
Elog Service
Elog Service API's are set of APIs that facilitates subscription and retrieval of event log (elog) descriptions from a robot controller. This service is used for tracking various system events and states in a robot controller in real-time.
version: 3HAC073675-001 Revision:L
title: Robot Web Services
tags:
- name: General Elog Service Actions
- name: Processes in Elog Domain
servers:
- url: https://127.0.0.1
description: Localhost VC
- url: https://192.168.125.1
description: RC MGMT connection
components:
securitySchemes:
basicAuth:
type: http
scheme: basic
paths:
/rw/elog:
get:
tags:
- General Elog Service Actions
summary: Get Elog Resources
description: "**Description :** \n\n\"Get a list of all elog domains. \nAlso supports getting the number of events in each domain and language specific names of the elog domains.\"\n \nThe current list of elog domains with short description is as below:\n\n \n+ **Common :** Contains the events from all logs (except \"Internal\", \"Configuration\" and \"RAPID\").\n \n+ **Operational :** Events dealing with handling of the system.\n \n+ **System :** Events dealing with system functions, system states, and so on.\n \n+ **Hardware :** Events dealing with system hardware, manipulators as well as controller hardware.\n \n+ **Program :** Events dealing with RAPID instructions, data, and so on.\n \n+ **Motion :** Events dealing with the control of the manipulator movements and positioning.\n \n+ **IO & Communication :** Events dealing with inputs and outputs, data buses, and so on.\n \n+ **User :** Events defined by the user.\n \n+ **Safety :** Events related to functional safety.\n \n+ **Internal :** Internal events for debug and service.\n \n+ **Process :** Application specific events, arc welding, spot welding, and so on.\n \n+ **Configuration :** Events dealing with the configuration of the system.\n \n+ **Paint :** Events related to Paint application.\n \n+ **RAPID :** RAPID build error log.\n \n+ **ConnectedServices :** Connected Service Embedded event logs which are generated during starting, registering, unregistering, losing connectivity, and so on.\r\n\n\n**Pre-requisites**: None\r\n\n\n**Limitation**: None\r\n\n\n**Sample Call**: \n\n curl -u \"Default User\":robotics -H \"accept: application/xhtml+xml;v=2.0\" \"https://localhost/rw/elog\" \n\n curl -u \"Default User\":robotics -H \"accept: application/xhtml+xml;v=2.0\" \"https://localhost/rw/elog?lang=de\" \n\n\n\n**Example java script**: \n```\nconst https = require('https')\nprocess.env.NODE_TLS_REJECT_UNAUTHORIZED = \"0\";\n//provide the user id and passowrd\nlet encoded = Buffer.from(\"Default user:robotics\").toString('base64')\n\nvar auth = \"Basic \" + encoded;\nconst options = {\n hostname: 'localhost',\n port: 443,\n path: '/rw/elog',\n method: 'GET',\n headers:{\n 'Accept': 'application/hal+json;v=2.0',\n 'Authorization': auth\n }\n}\n\nconst req = https.request(options, res => {\n console.log(`statusCode: ${res.statusCode}`)\n res.on('data', d => {\nprocess.stdout.write(d)\n})\n})\nreq.on('error', error => {\n console.error(error)\n})\nreq.end()\n```\n"
parameters:
- name: lang
in: query
description: >-
[language-code], a two letter language code e.g. en, sv, de, hi etc.
In addition to returning a list of all elog domain, this option
returns all the domain names in the specified language.
required: false
schema:
type: string
- name: resource
in: query
description: >-
count In addition to returning a list of all elog domain, this
option returns the number of elog messages in each elog domain.
required: false
schema:
type: string
responses:
'200':
description: Standard response for successful HTTP requests
content:
application/xhtml+xml;v=2.0:
schema:
properties:
elog-domain-li:
description: Specifies a link to the 'elog-domain` resource.
domain-name:
description: >-
[alphanumeric] The domain name in the specified language.
Available only when lang=xx query parameter is sent.
numevts:
description: >-
[numeric] The number of elog messages in the elog domain.
Available only when resource=count query parameter is
sent.
buffsize:
description: '[numeric] The elog buffer size of elog domain.'
xml:
name: data
wrapped: true
examples:
response:
value: >
- 31 1000
- 20 20
- 0 20
- 0 20
- 0 20
- 0 20
- 0 20
- 0 20
- 0 20
- 2 20
- 0 20
- 0 20
- 0 20
- 0 20
application/hal+json;v=2.0:
schema:
properties:
elog-domain-li:
description: Specifies a link to the 'elog-domain` resource.
domain-name:
description: >-
[alphanumeric] The domain name in the specified language.
Available only when lang=xx query parameter is sent.
numevts:
description: >-
[numeric] The number of elog messages in the elog domain.
Available only when resource=count query parameter is
sent.
buffsize:
description: '[numeric] The elog buffer size of elog domain.'
xml:
name: data
wrapped: true
'406':
description: >-
The server can only generate a response that is not accepted by the
client
security:
- basicAuth: []
/rw/elog/clearall:
post:
tags:
- General Elog Service Actions
summary: Clear Elog Messages
description: "**Description :**\n\n \"Clears all elog messages in all elog domains (except Internal).\"\r\n\n\n**Pre-requisites**: None\r\n\n\n**Limitation**: None\r\n\n\n**Sample Call**: \n\n curl -u \"Default User\":robotics -H \"Content-Type: application/x-www-form-urlencoded;v=2.0\" -X POST \"https://localhost/rw/elog/clearall\" \n\n\n\n**Example java script**: \n```\nconst https = require('https');\n //To disable SSL\n process.env.NODE_TLS_REJECT_UNAUTHORIZED = \"0\";\n const userId = process.env.USER_ID || 'Default user';\n const password = process.env.PASSWORD || 'robotics';\n let encoded = Buffer.from(`${userId}:${password}`).toString('base64');\n var auth = \"Basic \" + encoded;\n\n const options = {\n \t hostname: 'localhost',\n \t port: 443,\n \t path: '/rw/elog/clearall',\n \t method: 'POST',\n \t headers: {\n \t\t 'Accept': 'application/hal+json;v=2.0',\n \t\t 'Content-Type': 'application/x-www-form-urlencoded;v=2.0',\n \t\t 'Authorization': auth\n \t }\n };\n\n const req = https.request(options, res => {\n \t console.log(`statusCode: {res.statusCode}`);\n \t let responseBody = '';\n \t res.on('data', d => {\n \t\t responseBody += d;\n \t });\n \t res.on('end', () => {\n \t console.log(responseBody);\n \t if (res.headers.location) {\n \t\t console.log(res.headers.location);\n \t }\n \t });\n });\n\n req.on('error', error => {\n \t console.error(error);\n });\n\n req.end();\n```\n"
responses:
'204':
description: >-
The request has been successfully processed, but is not returning
any content
'400':
description: The request cannot be fulfilled due to bad syntax
'415':
description: >-
The server will not accept the request, because the media type is
not supported
security:
- basicAuth: []
/rw/elog/saveraw:
post:
tags:
- General Elog Service Actions
summary: Save Elog in System Dump Format
description: "**Description :**\n\n\"Save event log in system dump format on controller. Location header /progress/{id} will be returned after successful completion of the API.\nSince saving an elog in system dump format is an asynchronous task, the value of location\nheader can be subscribed on to get information about the status of the task.\"\n\nThe resource can be subscibed to get events with current status of saving elog. \nThe resource URI for this subscription will be /progress/{id}, where /progress/{id} \nis the\"location header\" returned after successful completion of \"Save elog in system dump\nformat\" API. \n\nSample responce for CFG Load subscription\n\n \n \n \n \n \n \n \n \n \n \n An event will look like\n \n \n \n \n \n \n \n \n \n\n\n\n**Pre-requisites**: None\r\n\n\n**Limitation**: None\r\n\n\n**Sample Call**: \n\n curl -u \"Default User\":robotics -H \"Content-Type: application/x-www-form-urlencoded;v=2.0\" -d \"path=/fileservice/$syspar/elog_dump.txt\" -X POST \"https://localhost/rw/elog/saveraw\" \n\n\n\n**Example java script**: \n```\nconst https = require('https')\n//To disable SSL\nprocess.env.NODE_TLS_REJECT_UNAUTHORIZED = \"0\";\n//provide the user id and passowrd\nlet encoded = Buffer.from(\"Default user:robotics\").toString('base64')\nconst data = 'path={string}';\nvar auth = \"Basic \" + encoded;\nconst options = {\n hostname: 'localhost',\n port: 443,\n path: '/rw/elog/saveraw',\n method: 'POST',\n headers:{\n 'Accept': 'application/hal+json;v=2.0',\n 'Content-Type': 'application/x-www-form-urlencoded;v=2.0',\n 'Authorization': auth,\n 'Content-Length': data.length\n }\n}\nconst req = https.request(options, res => {\n console.log(`statusCode: ${res.statusCode}`)\n res.on('data', d => {\n process.stdout.write(d)\n console.log(res.headers.location)\n})\n})\n req.on('error', error => {\n console.error(error)\n })\n req.write(data)\n req.end()\n```\n"
requestBody:
content:
application/x-www-form-urlencoded;v=2.0:
schema:
type: object
properties:
path:
description: >-
{path along with file-name which will contain the system
dump} Environment variables such as $Home, $Temp shall be
possible to have in the path.
type: string
example: path=string
description: Data parameter(s)
responses:
'202':
description: >-
The request has been accepted for processing, but the processing has
not been completed
'401':
description: >-
The request was a legal request, but the server is refusing to
respond to it. For use when authentication is possible but has
failed or not yet been provided
'403':
description: >-
The request was a legal request, but the server is refusing to
respond to it
'415':
description: >-
The server will not accept the request, because the media type is
not supported
security:
- basicAuth: []
/rw/elog/{domain-number}/clear:
post:
tags:
- Processes in Elog Domain
summary: Clear Elog Messages
description: "**Description :**\n\n \"Clears elog messages in this elog domain.\"\r\n\n\n**Pre-requisites**: None\r\n\n\n**Limitation**: None\r\n\n\n**Sample Call**: \n\n curl -u \"Default User\":robotics -H \"Content-Type: application/x-www-form-urlencoded;v=2.0\" -X POST \"https://localhost/rw/elog/0/clear\" \n\n\n\n**Example java script**: \n```\nconst https = require('https')\n//To disable SSL\nprocess.env.NODE_TLS_REJECT_UNAUTHORIZED = \"0\";\n//provide the user id and passowrd\nlet encoded = Buffer.from(\"Default user:robotics\").toString('base64')\nconst data = 'domain-number={domain-number}';\nvar auth = \"Basic \" + encoded;\nconst options = {\n hostname: 'localhost',\n port: 443,\n path: '/rw/elog/{domain-number}/clear',\n method: 'POST',\n headers:{\n 'Accept': 'application/hal+json;v=2.0',\n 'Content-Type': 'application/x-www-form-urlencoded;v=2.0',\n 'Authorization': auth,\n 'Content-Length': data.length\n }\n}\nconst req = https.request(options, res => {\n console.log(`statusCode: ${res.statusCode}`)\n res.on('data', d => {\n process.stdout.write(d)\n console.log(res.headers.location)\n})\n})\n req.on('error', error => {\n console.error(error)\n })\n req.write(data)\n req.end()\n```\n"
parameters:
- name: domain-number
in: path
description: '{domain-number}'
required: true
schema:
type: integer
responses:
'204':
description: >-
The request has been successfully processed, but is not returning
any content
'400':
description: The request cannot be fulfilled due to bad syntax
'404':
description: >-
The requested page could not be found but may be available again in
the future
'415':
description: >-
The server will not accept the request, because the media type is
not supported
security:
- basicAuth: []
/rw/elog/{domain-number}:
get:
tags:
- Processes in Elog Domain
summary: Get Elog Messages in Domain
description: "**Description :**\n\n \"Get a list of all elog messages in the given domain.\nAlso supports getting the number of events in the given domain, language specific elog\nmessages and title are only filtered.\nThe v=2.1 is supported from RW version 7.3.\nThe API with v=2.1 supports getting elog messages using sequence number and limit.\"\n\nThe resource can be subscribed (Elog domain) using /subscription with resource uri \n/rw/elog/{domain-number}\n\nSample response for Elog domain subscription\n\n```\n\n\n\n\n\n\n\n\n