Skip to main content

Orgvue API Debug Guide

Need to troubleshoot an issue with the Orgvue API?

This guide helps you identify the data and actions required for an effective investigation, particularly when using asynchronous processes.

Step-by-step​

  • Poll the "_links.self.href" endpoint regularly.
  • Wait until the jobStatus field is "completed".
  • Once completed, two URLs will be returned:
  • Success/Failure results are provided via the "_links.result.href" URL.

This is the file that you will need to identify why your request has not completed correctly

Download the job result data​

If your process uses Orgvue’s asynchronous API, you’ll need to poll the job status before retrieving the final result.

See Asynchronous result for further details

Example (simplified)

{
  "jobStatus": "completed",
  "_links": {
    "self": {
      "href": "https://.../jobs/abc123"
    },
    "result": {
      "href": "https://.../results/xyz456"
    }
  }
}

Understand error codes​

If the result contains an error, use the Orgvue error guide to interpret what went wrong and how to fix it:

Each error response includes:

  • An Orgvue-specific error code
  • A short message
  • A description of what caused the issue
  • Suggested next steps

Sending the full API request detail​

If you require further assistance from our support team or developers to investigate, please share the following:

  • Full API endpoint (e.g. https://api.orgvue.com/v1/async/jobs)
  • HTTP method used (e.g. POST, GET)
  • Headers included in the request
  • Request parameters and payload
  • Always include the timestamp of your request
  • If possible, provide the Orgvue user or system account making the request.

This gives us the full context of what the system is being asked to do.

When reporting errors, include the error message and code verbatim.