Top Menu

Jump to content
Home
    Modules
      • Projects
      • Activity
      • Work packages
      • Gantt charts
      • Calendars
      • Team planners
      • Boards
      • 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
    • Upgrade to Enterprise edition
    • User guides
    • Videos
    • Shortcuts
    • Community forum
    • Enterprise 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?

      or sign in with your existing account

      Google

Side Menu

  • Overview
  • Activity
    Activity
  • Roadmap
  • Work packages
    Work packages
  • Gantt charts
    Gantt charts
  • Calendars
    Calendars
  • Team planners
    Team planners
  • Boards
    Boards
  • News
  • Forums

Content

Development
  1. OpenProject
  2. Forums
  3. Development
  4. Project API for custom fields

Project API for custom fields

Added by Alex Z over 6 years ago

Hello,

I'm wondering if there is any way to get value of custom fields for Project through API?

According to API that I found, currently it's impossible to get custom fields for Projects: http://docs.openproject.org/apiv3-doc/#projects.  Compare to API for Work Packages where we can get this information (will be attached to `_links` object).

Is there any plan to support this?


Replies (6)

RE: Project API for custom fields - Added by Niels Lindenthal over 6 years ago

Hi Alex,

for Q1/Q2 2019 we plan an API for custom fields that allows you to CRUD custom fields. 

Does this help?

Best
Niels

RE: Project API for custom fields - Added by Alex Z over 6 years ago

Hi, Niels

Yes, this is exactly what I want! Thank you for prompt reply

Sincerely, Alex

RE: Project API for custom fields - Added by Christian Sicari about 4 years ago

Any news about that? These apis are not available yet

Niels Lindenthal wrote:

Hi Alex,

for Q1/Q2 2019 we plan an API for custom fields that allows you to CRUD custom fields.

Does this help?

Best
Niels

RE: Project API for custom fields - Added by Niels Lindenthal about 4 years ago

Hi Christian,

yes, there were some other feature prioritized. There are good chances that we will implement it as part of 12.0 (Q3 2021). It is a co-sponsorship with Deutsche Bahn.

Best

Niels

RE: Project API for custom fields - Added by Uzumaki Bey over 1 year ago

Hello, 

Any news guys please about this ? 

Best regards

RE: Project API for custom fields - Added by SIddharth L about 1 year ago

Uzumaki Bey wrote:

Hello,

Any news guys please about this ?

Best regards

As of now in API/v3,

If you have custom fields like feeding the input directly (Example: Date, Text, Integer, etc.), you can use the custom field name in the payload. 
Suppose if your custom fields are lists, then you should know the custom field name and each custom option ID.

I hope it will help you.

//To Map custom Option  with it's ID

const customOptionsIdMap = {
  "XXX": 1,
  "YYY": 2,
  "ZZZ": 3,
};


//Direct Input
payload["customField1"] = "Input";

//DropDown Input or List
payload["customField2"] = {
  href: "/api/v3/custom_options/" + customOptionsIdMap[XXX],
};
  • (1 - 6/6)
Loading...