Openlinksw

OSDB REST API v1

An OpenAPI description of the OpenLink Smart Data Bot REST API v1

Developer tools#openapi#developer-tools

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

An OpenAPI description of the OpenLink Smart Data Bot REST API v1

Endpoints 10

OSDB

  • GETList actions/api/v1/actions/:serviceIdReturns an array of action descriptions for the actions supported by the given service
  • GETDescribe action/api/v1/actions/:serviceId/:actionIdReturns a description of a given service action.
  • POSTExecute action/api/v1/actions/:serviceId/:actionId/execExecutes a registered service action and returns any output from the action. The data returned in the POST response body may be: * the raw action output, * a…
  • GETAction help/api/v1/actions/:serviceId/:actionId/helpReturns the help text for a given service action
  • GETLogin/api/v1/loginLogs a user into the OSDB server, authenticating them by their WebID and returning an OSDB session ID in cookie osdb.sid
  • GETLogout/api/v1/logoutLogs a user out of the OSDB server, ending their OSDB session
  • GETList services/api/v1/servicesReturns descriptions of all services registered with the OSDB server.
  • POSTLoad service/api/v1/servicesLoads a service description into the OSDB Service Registry
  • GETDescribe service/api/v1/services/:serviceIdReturns a description of a given service
  • DELETEUnload service/api/v1/services/:serviceIdRemoves a service description from the OSDB Service Registry

API details

Base URL
https://osdb.openlinksw.com/osdb
Authentication
None declared in the description
Operations
10 operations on 8 pathsGET 7POST 2DELETE 1
Main resources
OSDB 10
Response formats
application/json */*
Description format
OpenAPI 3.0.0, API version 1.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the OSDB REST API v1 in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the OSDB REST API v1 collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “List actions” (GET /api/v1/actions/:serviceId), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the OSDB REST API v1?

An OpenAPI description of the OpenLink Smart Data Bot REST API v1 It is listed under Developer tools and has 10 endpoints.

Who publishes the OSDB REST API v1?

It is listed from Openlinksw's public API description (an OpenAPI document), not published by Openlinksw on Swastik Codes. Anyone who controls openlinksw.com can claim the profile by adding a DNS TXT record.

What is the base URL of the OSDB REST API v1?

Requests go to https://osdb.openlinksw.com/osdb. Endpoint paths are added to this base URL.

How do I authenticate with the OSDB REST API v1?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the OSDB REST API v1 have?

10 operations on 8 paths (7 GET, 2 POST, 1 DELETE). The largest groups are OSDB.

Is forking the OSDB REST API v1 free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.