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
      • Hierarchy leafWiki
You are here:
  • Forums
  • Development

Content

API: Create workpackage with a customfield

Added by Robert Alers over 4 years ago

Use case:

Writing a simple VBA application for importing excel files into openproject.

What works:

A post to /work_packages with basis auth and the following JSON body:

{ "subject": "the subject",  "description": { "raw": "the description" }, "startDate": "2018-09-29" }

This works perfectly, although when I try to push a custom field, like so:

{ "subject": "the subject",  "description": { "raw": "the description" }, "customField8": "CustomField TEST", "startDate": "2018-09-29" }

The custom field stays 'null'. Data type for this specific field is as follows:

"customField8": {
       "type": "String",
       "name": "Source",
       "required": false,
       "hasDefault": false,
       "writable": true,
       "visibility": "default"
   },

What am i missing?

Thanks in advance!


Replies (11)

RE: API: Create workpackage with a customfield - Added by Bernd Petraus over 4 years ago

Hi Robert,

i've done something very similar (get, create and edit workpackages with any kind of attributes), I would like to share with you.

Whats missing is some refacotring and claning up some hardcoded stuff, that was meant for testing. So, please give me a weekend or something.

But anyway, what response do you get?

Btw.: I would highly recommend this JsonParser, if you are familiar with dictionaries and collections in Excel: https://github.com/VBA-tools/VBA-JSON

Best Regards

Bernd

RE: API: Create workpackage with a customfield - Added by Robert Alers over 4 years ago

Hi Bernd,

Thank you for the reply!

I get the standard response: 201 - Created with a list of all fields, note that the customField8 stays NULL.

Thanks for the tip! I already used the JsonParser module in my current project. Are you writing an excel addon by any chance? This would be awesome for people migrating to the OpenProject platform.

Love to hear if you can resolve this issue!

Regards,

Robert

RE: API: Create workpackage with a customfield - Added by Bernd Petraus over 4 years ago

Hi Robert,

creating a addon out of my *.xlsm would make sense. Let me think about... But you will get the Excel-Tool anyway.

Hm, do you use the response from form validation for creating your body?

Best regards

Bernd

RE: API: Create workpackage with a customfield - Added by Robert Alers over 4 years ago

Hi Bernd,

I did use the form as base..

Did you made any progress? something you think I can try? I am at my wits end here :-)

Regards,

Robert

RE: API: Create workpackage with a customfield - Added by Bernd Petraus over 4 years ago

Hi Robert,

it's still not finished, but i've uploaded my Excel-file to github: https://github.com/opf/OpenProjectExcel

Hopefully it works for you.

Please let me know, if you're not able to figure out, how it works.

I will make a Addin out of this, but not now.

Best regards

Bernd

RE: API: Create workpackage with a customfield - Added by Robert Alers over 4 years ago

Hi Bernd,

Very well done! My deepest thanks for all the work you put in!

I hope I have time this week to play with this, and squash some bugs (It gives me a lot of errors, but this tends to be the case with VBA :-) )

Will get back to you, and maybe I have I fixed the customfield problem by then.

Thanks again,

Robert

RE: API: Create workpackage with a customfield - Added by Bernd Petraus over 4 years ago

Hi Robert,

thanks for your response!

I have no problem with any kind of customfield. So it should work for you, after figuring out, whats the issue regarding VBA.

Can you please give me report of the bugs you get, including Operating System, Excel Version ect.? I shouldn't be a problem to make the Excel stable in any situation. Theres nothing special inside. I just have to know the situation.

Best Regards

Bernd

RE: API: Create workpackage with a customfield - Added by Niels Lindenthal over 4 years ago

Hi @Bernd and @Robert,

I just created a public project for you guys here:

https://community.openproject.com/projects/excel-sync/work_packages

This might help you to track your activities.

Best

Niels

RE: API: Create workpackage with a customfield - Added by Bernd Petraus over 4 years ago

Thanks, Niels! We'll surely make use of this.

@Robert: I recently added the implemented librarys in github: Visual Basic For Applications, Microsoft Excel 16.0 Object Library, Microsoft Forms 2.0 Object Library, Microsoft Scripting Runtime, Microsoft WinHTTP Services, version 5.1. Maybe you're missing some of theese. If so, please let me know. I don't need all of them at all.

RE: API: Create workpackage with a customfield - Added by Robert Alers over 4 years ago

Thanks Bernd and Niels!

I checked al the references you listed, same story. (Even the version numbers check out)

I used the public project for listing the first bugs I got, and will try debug them myself. Although my VBA skills are a hell of a lot less then yours i'm afraid ;-)

RE: API: Create workpackage with a customfield - Added by Bernd Petraus over 4 years ago

@Robert Did some debugging. Please check the actual version on github and our project.

@Niels I can not assign Robert. Additionaly the status test or something would be helpful.

Best Regards

Bernd

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