Getting started with the BMC Helix Digital Workplace Catalog REST API
The API follows the REST architectural style, so resources, HTTP verbs, and status codes are used. JSON is used for request and response bodies.
Required license
Transport scheme
Access to the BMC Helix Digital Workplace Catalog REST API is over the transport scheme configured for your application server, either HTTP or HTTPS. You can call API endpoints from any scripting or programming language that supports the configured transport scheme.
The default configuration supports an HTTP connection.
Base URI
The following base URI is used for calling the BMC Helix Digital Workplace Catalog server: /api/myit-sb/
Call the API endpoint from the full application host URL. If the host URL includes a port number, include the port number in your requests. Preface the URL with the correct scheme (HTTP/HTTPS).
Following are examples of the base URI:
Base URI format type | Example |
|---|---|
Local machine | http://localhost:8008/api/myit-sb |
HTTPS connection | https://calbroservices.com:8008/api/myit-sb |
HTTP connection | http://calbroservices.com:8008/api/myit-sb |
A server without a port assigned to it | http://calbroservices.com/api/myit-sb |
Default header
Unless an API endpoint requires a different header, the following header is required for all requests:
Content-Type: application/json
X-Requested-By: <any_value>
Authentication
To be able to make REST API calls, you need to log in to the application by using the users/login endpoint to be granted a session token, which is valid for about 30 minutes. The system-generated token must be included in all subsequent calls for the system to trust requests from the application or script that has been granted that token. This token is typically sent back and forth as a AR-JWT cookie, although it can also be included inside the header.