Top Menu

Jump to content
Home
    • Projects
    • Work packages
    • News
    • Getting started
    • Introduction video
      Welcome to OpenProject Community
      Get a quick overview of project management and team collaboration with OpenProject. You can restart this video from the help menu.

    • Help and support
    • User guides
    • Videos
    • Shortcuts
    • Community forum
    • Professional support

    • Additional resources
    • Data privacy and security policy
    • Digital accessibility (DE)
    • OpenProject website
    • Security alerts / Newsletter
    • OpenProject blog
    • Release notes
    • Report a bug
    • Development roadmap
    • Add and edit translations
    • API documentation
  • Sign in
      Forgot your password?
      Create a new account

      or sign in with your existing account

      Google

Side Menu

  • Overview
  • Activity
  • Roadmap
  • Work packages
  • Calendars
  • Team planners
  • Boards
  • Forums
  • Wiki
    • Table of contents
      • Expanded. Click to collapseCollapsed. Click to showDeveloper
        • Hierarchy leafAccessibility Checklist
        • Hierarchy leafCode Review Guidelines
        • Expanded. Click to collapseCollapsed. Click to showContribution
          • Hierarchy leafGit Workflow
          • Hierarchy leafTranslations
        • Expanded. Click to collapseCollapsed. Click to showDeveloping Plugins
          • Hierarchy leafDeveloping an OmniAuth Authentication Plugin
        • Hierarchy leafRelease Process
        • Hierarchy leafReport a bug
        • Hierarchy leafSecurity
        • Hierarchy leafSetting up an OpenLDAP server for testing
        • Hierarchy leafTheme Features
      • Hierarchy leafDownload
      • Expanded. Click to collapseCollapsed. Click to showFeature tour
        • Hierarchy leafRelease Notes OpenProject 30
        • Expanded. Click to collapseCollapsed. Click to showRelease Notes OpenProject 30 - Overview
          • Hierarchy leafGlossary
          • Hierarchy leafRelease Notes - Accessibility
          • Hierarchy leafRelease Notes - Accessibility changes
          • Hierarchy leafRelease Notes - Add work package queries as menu items to sidebar
          • Hierarchy leafRelease Notes - Copy projects based on Templates
          • Hierarchy leafRelease Notes - Design changes
          • Hierarchy leafRelease Notes - Fixed Bugs
          • Hierarchy leafRelease Notes - Keyboard Shortcuts
          • Hierarchy leafRelease Notes - Project settings
          • Hierarchy leafRelease Notes - Ruby&Rails Update
          • Hierarchy leafRelease Notes - Security
          • Hierarchy leafRelease Notes - Timelines
          • Hierarchy leafRelease Notes - Work packages
      • Hierarchy leafHowto create animated gifs
      • Hierarchy leafMigration Squashing
      • Hierarchy leafMod security
      • Hierarchy leafNew work package page
      • Hierarchy leafOP3 to OP4 Debian upgrade
      • Hierarchy leafOP4 Ubuntu1404 Stable with MySQL in production
      • Hierarchy leafOpenProject 40 Development Setup
      • Expanded. Click to collapseCollapsed. Click to showOpenProject Foundation
        • Hierarchy leafBoards
        • Hierarchy leafMembers
        • Hierarchy leafOPF-Meetings
        • Hierarchy leafStatutes
      • Expanded. Click to collapseCollapsed. Click to showRelease Notes
        • Hierarchy leafOpenProject released on Bitnami
      • Expanded. Click to collapseCollapsed. Click to showRelease Notes OpenProject 40 - Overview
        • Hierarchy leafRelease Notes OpenProject 40 - Accessibility improvements
        • Hierarchy leafRelease Notes OpenProject 40 - Column header functions in work package table
        • Hierarchy leafRelease Notes OpenProject 40 - Improved Design
        • Hierarchy leafRelease Notes OpenProject 40 - Integrated query title on work package page
        • Hierarchy leafRelease Notes OpenProject 40 - Integrated toolbar on work package page
        • Hierarchy leafRelease Notes OpenProject 40 - OmniAuth integration for OpenProject
        • Hierarchy leafRelease Notes OpenProject 40 - Work package details pane
      • Expanded. Click to collapseCollapsed. Click to showSecurity and privacy
        • Hierarchy leafFAQ
      • Expanded. Click to collapseCollapsed. Click to showSupport
        • Expanded. Click to collapseCollapsed. Click to showDownload and Installation
          • Hierarchy leafInstallation MacOS
          • Expanded. Click to collapseCollapsed. Click to showInstallation OpenProject 3 0
            • Hierarchy leafDebian Stable with MySQL in production
            • Hierarchy leafInstallation Ubuntu
            • Hierarchy leafInstallation Windows
            • Hierarchy leafInstallation on Centos 65 x64 with Apache and PostgreSQL 93
          • Expanded. Click to collapseCollapsed. Click to showInstallation OpenProject 40
            • Hierarchy leafOP4 Debian Stable with MySQL in production
          • Expanded. Click to collapseCollapsed. Click to showMigration paths
            • Hierarchy leafFrom Chilliproject to OpenProject
            • Hierarchy leafMigration 15 to 30
            • Hierarchy leafMigration 24 to 30
            • Hierarchy leafMigration Redmine 2x › OpenProject 30
            • Hierarchy leafOpenProject 3 Migration
          • Hierarchy leafOpenProject 40
        • Expanded. Click to collapseCollapsed. Click to showNews
          • Hierarchy leafNew OpenProject Translations Plugin
          • Hierarchy leafNew Plugin on OpenProjectorg Local Avatars
          • Hierarchy leafNew design for OpenProject
          • Hierarchy leafNews Accessibility workshop for OpenProject
          • Hierarchy leafNews Glossary for OpenProject
          • Hierarchy leafNews Heartbleed fixed
          • Hierarchy leafNews Icon Fonts
          • Hierarchy leafNews OpenProject 30 Release
          • Hierarchy leafNews Release GitHub Integration Plugin
          • Hierarchy leafNews Success Story Deutsche Telekom
          • Hierarchy leafNews Timelines
          • Hierarchy leafOpenProject 3013 released
          • Hierarchy leafOpenProject 3017 released
          • Hierarchy leafOpenProject 40 released
          • Hierarchy leafOpenProject 40 will be coming soon
          • Hierarchy leafOpenProject 405 released
          • Hierarchy leafOpenProject and pkgrio
          • Hierarchy leafOpenProject news moved to a new blog
          • Hierarchy leafOpenProjectBitnami
          • Hierarchy leafPackager version with plugins released ("Community edition")
          • Hierarchy leafRegistration OpenProject-Foundation
          • Hierarchy leafRelease OpenProject AuthPlugins
          • Hierarchy leafUpdates on OpenProject
          • Hierarchy leafWe need your feedback for the the new fullscreen view for work packages
        • Hierarchy leafOpenProject Plug-Ins
      • Expanded. Click to collapseCollapsed. Click to showWiki
        • Hierarchy leaf2nd Level Support
You are here:
  • Forums
  • Development

Content

Internal error occured by API call

Added by Michael Freitter over 7 years ago

Greetings,

I call a API to add a workpackage to my openproject instance, but an error occured;

" Dim addWPUrl As String = “https://openproject.domain.at/api/v2/projects/test_project/planning_elements.json?key=” + APIKey"
‘{“”planning_element“”: {“”subject“”: “”Test Issue“”, “”status_id“”: 1, “”type_id“”: 2, “”priority_id“”: 2}’

Error text:
“Internal error
An error occurred on the page you were trying to access.
If you continue to experience problems please contact your OpenProject administrator for assistance.”

How can I find the reason of this error?

Thank you!
Michael


Replies (8)

RE: Internal error occured by API call - Added by Jan Sandbrink over 7 years ago

Hello Michael,

Not sure if it is because of my missing VB reading skills, but the request you are sending looks weird: Are those double double quotes around your string values?

E.g. ""planning_element"": should read "planningElement":

In any case there is at least some error on the OpenProject side, at least in that it returns an HTTP 500 when it should return some 4xx status.

Since we are not maintaining APIv2 actively anymore I’d advise you to use the APIv3 endpoint to create a work package (added in OpenProject 4.2).

You can find the documentation for APIv3 here: https://www.openproject.org/api

APIv3 should have better error messages than APIv2, if you still encounter errors don’t hesitate to contact us again.

Best regards
Jan Sandbrink

RE: Internal error occured by API call - Added by Michael Freitter over 7 years ago

Hello Jan,

thank you for your information, but I get also the 500 error.
Here is the whole sample code in Visual basic:

@ Public Function addWP(ByVal ProjectID As Integer, ByVal Subject As String) As JObject

Dim urlParmsHead As New JObject()
Dim urlParms As New JObject()
Dim vals As New JArray()

Dim addWPUrl As String = “https://openproject.domain.xy/api/v3/projects/” + ProjectID.ToString.Trim() + “/work_packages”
urlParms(“subject”) = Subject
urlParms(“_links”) = “{ ”“status”“: {”“href”“:”“/api/v3/statuses/1”“}, ”“type”“: { ”“href”“:”“/api/v3/types/2”" }, “”priority“”: { “”href“”:“”/api/v3/priorities/2“” }}"
Dim rObject = InvokeMethodPut(addWPUrl, “POST”, urlParms)
Return rObject

End Function@

Have you an additional idea, why the error occured?

Regards
Michael

RE: Internal error occured by API call - Added by Jan Sandbrink over 7 years ago

Are you actually passing subject and _links as url parameters? (asking because of the name urlParms)

You should pass the JSON object in the body of the POST call.

I would also be interested in the full response by the OpenProject instance (i.e. the error message).
Is your OP instance running in production mode or in development mode?

RE: Internal error occured by API call - Added by Jan Sandbrink over 7 years ago

Btw. for posting multiline code (or logs) in this forum, you can escape using the pre tags.

E.g.

<pre>
1
2
3

RE: Internal error occured by API call - Added by Michael Freitter over 7 years ago

Is your OP instance running in production mode or in development mode?

I don’t know. I have installed my openproject instance by a company.
How can I find out which mode my OpenProject is running?

RE: Internal error occured by API call - Added by Michael Freitter over 7 years ago

Hello Jan,

have you an example code (no matter what programming language) where you add a workpackage to a existing project in OpenProject?
Regards
Michael

RE: Internal error occured by API call - Added by Jan Sandbrink over 7 years ago

We do it in our integrative RSpec tests:
https://github.com/opf/openproject/blob/2199b22f0ec66b84f130c294f0692210ce082de9/spec/requests/api/v3/work_packages/work_packages_by_project_resource_spec.rb#L87

It is something along the lines:

POST example.com/api/v3/projects/1/work_packages

{
  "subject": "I am a work package!"
}

There might be various cases where you are not able to add a work package:

  • no permissions (not logged in?)
  • missing required fields
  • invalid inputs
  • etc

However:
Whenever something goes wrong, the server should respond with a meaningful error message. Therefore I’d really like to know what that error message is, you are receiving. E.g.

{
    "_type": "Error",
    "errorIdentifier": "urn:openproject-org:api:v3:errors:InvalidRequestBody",
    "message": "The request body was not a single JSON object."
}

RE: Internal error occured by API call - Added by Michael Freitter over 7 years ago

Thank you!
I have now upgrade from version 4.1 to 4.2 and now I can create a workpackage.

Unfortunately, I can’t delete a workpackage, but I open a new ticket.

Thank you!
Michael

  • (1 - 8/8)
Loading...