Design: Speed issues & timeout errors

Modified on Thu, 21 Mar 2024 at 10:50 AM

If you are experiencing speed issues or timeout errors, there are two solutions that we would advise.

1) Use pagination. If you are trying to access a sizeable BoM and many files from the BoM, you may hit a timeout issue. We would suggest paginating through your BoM items.

Here is an example:

query bomIdPagination {
  desBomById(
    id: "RGV..."
  ) {
    id
    #After value is the end cursor for the previous page
    items(first: 5, after: "OQ==") {
      nodes {
        quantity
        bomItemInstances {
          designator
        }
        component {
          details {
            parameters {
              name
              value
            }
          }
          name
          description
          isManaged
        }
      }
      pageInfo {
        endCursor
      }
    }
  }
}

2) Use regional endpoints. The data sometimes lives in a different region to where our standard API endpoint. You can try calling this query to find the API endpoint for your workspace, and change the configuration using the new API endpoint.

query regionalEndpoint{
  desWorkspaceByUrl(workspaceUrl:"https://altium-inc-1234.365.altium.com/") {
    location {
      name
      apiServiceUrl
    }
  }
}