Troubleshooting API issues

The Blueworks Live API enables limited interactions such as searching for artifacts, retrieving process details, and initiating work instances. While most responses are returned in JSON format, interpreting these responses correctly is key to successful integration. Use the troubleshooting section to focus on identifying and resolving common issues. The issues that arise during API usage, including authentication errors, token expiration, and rate limiting. It also provides practical examples and guidance to help you troubleshoot effectively and maintain smooth API operations.

Note: API documentation migrated to IBM API Hub External link opens a new window or tab. Find the latest updates and documentation for Blueworks Live APIs in API Hub.

Common errors and solutions

Error Code Description Possible Cause Action
401 Unauthorized The request lacks valid authentication credentials.
  • The access token expired
  • The token is missing or malformed
  • Reauthenticate and obtain a new token.
  • Ensure that the token is included in the Authorization header
403 Forbidden The server processed the request but access is denied.
  • The user does not have permission to access the resource
  • API access is restricted
  • Verify user roles and permissions
  • Confirm that the API endpoint is accessible to your account
429 Too Many Requests Rate limit exceeded. Too many requests sent in a short time
  • Wait and retry after the time specified in the Retry-After header
  • Implement exponential back off in your client
400 Bad Request The server might not understand the request.
  • Malformed request syntax
  • Missing required parameters
  • Check the request format and required fields
  • Validate input data
500 Internal Server Error An unexpected error occurred on the server. Server-side issue
  • Retry after some time
  • Contact support if the issue persists

Understanding and resolving API issues

Action Area Description
Check Token Validity Ensure that your access token is current and correctly formatted.
Verify Permissions Confirm that the authenticated user has the necessary roles and access rights.
Review API Usage Monitor your request rate and adjust your client to avoid pressing rate limits.
Inspect Request Format Use tools like Postman or curl to validate your request structure.