Skip to Content
Odoo Menu
  • Sign in
  • Try it free
  • Apps
    Finance
    • Accounting
    • Invoicing
    • Expenses
    • Spreadsheet (BI)
    • Documents
    • Sign
    Sales
    • CRM
    • Sales
    • POS Shop
    • POS Restaurant
    • Subscriptions
    • Rental
    Websites
    • Website Builder
    • eCommerce
    • Blog
    • Forum
    • Live Chat
    • eLearning
    Supply Chain
    • Inventory
    • Manufacturing
    • PLM
    • Purchase
    • Maintenance
    • Quality
    Human Resources
    • Employees
    • Recruitment
    • Time Off
    • Appraisals
    • Referrals
    • Fleet
    Marketing
    • Social Marketing
    • Email Marketing
    • SMS Marketing
    • Events
    • Marketing Automation
    • Surveys
    Services
    • Project
    • Timesheets
    • Field Service
    • Helpdesk
    • Planning
    • Appointments
    Productivity
    • Discuss
    • Artificial Intelligence
    • IoT
    • VoIP
    • Knowledge
    • WhatsApp
    Third party apps Odoo Studio Odoo Cloud Platform
  • Industries
    Retail
    • Book Store
    • Clothing Store
    • Furniture Store
    • Grocery Store
    • Hardware Store
    • Toy Store
    Food & Hospitality
    • Bar and Pub
    • Restaurant
    • Fast Food
    • Guest House
    • Beverage Distributor
    • Hotel
    Real Estate
    • Real Estate Agency
    • Architecture Firm
    • Construction
    • Property Management
    • Gardening
    • Property Owner Association
    Consulting
    • Accounting Firm
    • Odoo Partner
    • Marketing Agency
    • Law firm
    • Talent Acquisition
    • Audit & Certification
    Manufacturing
    • Textile
    • Metal
    • Furnitures
    • Food
    • Brewery
    • Corporate Gifts
    Health & Fitness
    • Sports Club
    • Eyewear Store
    • Fitness Center
    • Wellness Practitioners
    • Pharmacy
    • Hair Salon
    Trades
    • Handyman
    • IT Hardware & Support
    • Solar Energy Systems
    • Shoe Maker
    • Cleaning Services
    • HVAC Services
    Others
    • Nonprofit Organization
    • Environmental Agency
    • Billboard Rental
    • Photography
    • Bike Leasing
    • Software Reseller
    Browse all Industries
  • Community
    Learn
    • Tutorials
    • Documentation
    • Certifications
    • Training
    • Blog
    • Podcast
    Empower Education
    • Education Program
    • Scale Up! Business Game
    • Visit Odoo
    Get the Software
    • Download
    • Compare Editions
    • Releases
    Collaborate
    • Github
    • Forum
    • Events
    • Translations
    • Become a Partner
    • Services for Partners
    • Register your Accounting Firm
    Get Services
    • Find a Partner
    • Find an Accountant
    • Meet an advisor
    • Implementation Services
    • Customer References
    • Support
    • Upgrades
    Github Youtube Twitter Linkedin Instagram Facebook Spotify
    +1 (650) 691-3277
    Get a demo
  • Pricing
  • Help
You need to be registered to interact with the community.
All Posts People Badges
Tags (View all)
odoo accounting v14 pos v15
About this forum
You need to be registered to interact with the community.
All Posts People Badges
Tags (View all)
odoo accounting v14 pos v15
About this forum
Help

How to access Worksheet details via JSON RPC API

Subscribe

Get notified when there's activity on this post

This question has been flagged
projectapitaskproject.task
2 Replies
3954 Views
Avatar
Jimi

Hello,

I'm currently building a pipeline to integrate Odoo with one of my services. As part of this, I need to access the content of the worksheet linked to a project task.

I've been exploring the JSON-RPC API, but I’m having trouble retrieving the actual content of the worksheet. So far, I can only retrieve the worksheet template, its ID, and the count — but not the detailed content (e.g., text fields or values entered in the worksheet by users).

My goal is to add a button on the task dashboard that triggers a webhook. This webhook should launch an API call to retrieve all relevant task information, including the associated worksheet content.

Has anyone done something similar or knows how to access the worksheet data through the API?

Thanks in advance!

0
Avatar
Discard
Avatar
Jimi
Author Best Answer

Thank you for the help. I manage to figure it out

0
Avatar
Discard
Avatar
Christoph Farnleitner
Best Answer

Depends on what worksheet data means exactly.

If you're talking about the fields defined within a worksheet, you'll have to go for ir.model.fields. If you're after the actual data entered into such a worksheet, you have to go for 'that worksheet model'.

A working example for both cases:

import xmlrpc.client

url = 'https://subdomain.odoo.com'
db = 'dbname'
username = 'username'
password = 'password'

# Worksheet Templates are defined on Projects (project.project)
# and can be overridden on Tasks (project.task).
# Below example just goes by the task, but the same concept can
# be applied to project.project worksheet_template_id as well.
_task_id = 42

# Authentication
common = xmlrpc.client.ServerProxy('{}/xmlrpc/2/common'.format(url))
uid = common.authenticate(db, username, password, {})
models = xmlrpc.client.ServerProxy('{}/xmlrpc/2/object'.format(url))

# optional: perform additional search within the known task(s)
task_id = models.execute_kw(db, uid, password, 'project.task', 'search', [[['id', '=', _task_id]]])
print(f'task_id: {task_id}')
# result:
# task_id: [42]

# read the task data and receive 'fields' - here we're interested
# in the worksheet_template_id assigned to that task:
tasks = models.execute_kw(db, uid, password, 'project.task', 'read', [task_id], {'fields': ['worksheet_template_id']})
print(f'tasks: {tasks}')
# result:
# tasks: [{'id': 42, 'worksheet_template_id':
# [1, 'Default Worksheet']}]

# optional: perform additional search within the known worksheet
# templates; in case you've been searching for multiple tasks
# and have receveived multiple worksheet templates. at the end
# it just boils down to whether or not you want to / need to
# apply list comprehensions; for the sake of simplicity i'm just
# looking for the first worksheet template received:
worksheet_template_id = models.execute_kw(db, uid, password, 'worksheet.template', 'search', [[['id', '=', tasks[0].get('worksheet_template_id')[0]]]])
print(f'worksheet_template_id: {worksheet_template_id}')
# result:
# worksheet_template_id: [1]

# read the worksheet template data and receive 'fields' - here
# we're interested in the model_id. this is the model
# (ir.model record) that actually holds all the fields defined:
worksheet_templates = models.execute_kw(db, uid, password, 'worksheet.template', 'read', [worksheet_template_id], {'fields': ['model_id']})
print(f'worksheet_templates: {worksheet_templates}')
# result:
# worksheet_templates: [{'id': 1, 'model_id':
# [714, 'Default Worksheet']}]

# search for the fields assigned to that model:
worksheet_template_field_ids = models.execute_kw(db, uid, password, 'ir.model.fields', 'search', [[['model_id', '=', worksheet_templates[0].get('model_id')[0]]]])
print(f'worksheet_template_field_ids: {worksheet_template_field_ids}')
# result:
# worksheet_template_field_ids: [9922, 9921, 9920, 9919, 9924,
# 9923, 9917, 9918, 9916, 12565]

# read the fields data and receive 'fields' - this is just a
# reduced example returning only the name of the fields.
# highly depends on what information of the field definition
# your're interested in:
worksheet_template_fields = models.execute_kw(db, uid, password, 'ir.model.fields', 'read', [worksheet_template_field_ids], {'fields': ['name']})
print(f'worksheet_template_fields: {worksheet_template_fields}')
# result:
# worksheet_template_fields: [{'id': 9922, 'name': 'create_date'},
# {'id': 9921, 'name': 'create_uid'},
# {'id': 9920, 'name': 'display_name'},
# {'id': 9919, 'name': 'id'},
# {'id': 9924, 'name': 'write_date'},
# {'id': 9923, 'name': 'write_uid'},
# {'id': 9917, 'name': 'x_comments'},
# {'id': 9918, 'name': 'x_name'},
# {'id': 9916, 'name': 'x_project_task_id'},
# {'id': 12565, 'name': 'x_studio_a_field'}]

# now, since we know the worksheet template and the task, we
# can search for the actually filled up worksheet; again,
# limit the search if and as necessary:
filled_worksheet_ids = models.execute_kw(db, uid, password, 'x_project_task_worksheet_template_1', 'search', [[['x_project_task_id', '=', tasks[0].get('id')]]])
print(filled_worksheet_ids: {filled_worksheet_ids}')
# result:
# filled_worksheet_ids: [1]

# finally, fetch the user input for the worksheet:
worksheet_field_values = models.execute_kw(db, uid, password, 'x_project_task_worksheet_template_1', 'read', [filled_worksheet_ids])
print(f'worksheet_field_values: {worksheet_field_values}')
# result:
# worksheet_field_value_ids: [{'id': 1, 'display_name':
# 'S00001 - Installation',
# 'create_uid': [2, 'Administrator'],
# 'create_date': '2025-06-23 21:20:13',
# 'write_uid': [2, 'Administrator'],
# 'write_date': '2025-06-23 21:20:13',
# 'x_studio_a_field': 'a user input',
# 'x_project_task_id': [
# 3, 'S00001 - Installation'],
# 'x_comments': '<p>some random comment
# entered in the worksheet</p>',
# 'x_name': 'S00001 - Installation'}]


Please note that this is an example and not a production-ready setup. It is supposed to showcases how worksheet data is linked to a task.
You definitely want to make sure that errors, missing or empty values/records etc. are handled appropriately (and double-check in case I've mixed up a id with a template-id).


As a summary:

  1. get the Worksheet Template for the Project Task
  2. find the actual model and fields defining the Worksheet Template
  3. get the user input from the worksheet


0
Avatar
Discard
Enjoying the discussion? Don't just read, join in!

Create an account today to enjoy exclusive features and engage with our awesome community!

Sign up
Related Posts Replies Views Activity
Show tasks in kanban view of the project module
project task kanban project.task
Avatar
Avatar
1
Feb 22
4653
How to hide sub task from clients
project task tasks project.task
Avatar
0
May 21
3736
¿Existe algún método o modulo que me permite programar actividades y que de manera automática todas las actividades se ajusten a fechas nuevas dependiendo de cual sea el tiempo de retraso de la actividad actual?
project task
Avatar
Avatar
1
Feb 26
1502
Odoo 17 - Tasks that depend on events AND milestones
project task
Avatar
Avatar
1
Dec 25
1997
v16 Tasks visibility
project task
Avatar
Avatar
1
Jun 23
5508
Community
  • Tutorials
  • Documentation
  • Forum
Open Source
  • Download
  • Github
  • Runbot
  • Translations
Services
  • Odoo.sh Hosting
  • Support
  • Upgrade
  • Custom Developments
  • Education
  • Find an Accountant
  • Find a Partner
  • Become a Partner
About us
  • Our company
  • Brand Assets
  • Contact us
  • Jobs
  • Events
  • Podcast
  • Blog
  • Customers
  • Legal • Privacy
  • Security
الْعَرَبيّة Català 简体中文 繁體中文 (台灣) Čeština Dansk Nederlands English Suomi Français Deutsch हिंदी Bahasa Indonesia Italiano 日本語 한국어 (KR) Lietuvių kalba Język polski Português (BR) română русский язык Slovenský jazyk Slovenščina Español (América Latina) Español Svenska ภาษาไทย Türkçe українська Tiếng Việt

Odoo is a suite of open source business apps that cover all your company needs: CRM, eCommerce, accounting, inventory, point of sale, project management, etc.

Odoo's unique value proposition is to be at the same time very easy to use and fully integrated.

Website made with

Odoo Experience on YouTube

1. Use the live chat to ask your questions.
2. The operator answers within a few minutes.

Live support on Youtube
Watch now