Updates the work order with the specified key
Request Information
URI Parameters :
Name | Description | Type | Additional information |
---|---|---|---|
id | globally unique identifier |
Required |
Body Parameters :
jobsName | Description | Type | Additional information |
---|---|---|---|
id |
Primary Key |
globally unique identifier | |
_parent_id |
Reference to a parent job (in case of Multi Job) |
globally unique identifier | |
_parent_job |
Embedded entity "job" for parent (multi job level) when adding/updating job |
jobs | |
_parent_jobs_reference_back_office |
Embedded entity "job" for parent (multi job level) using ERP PK when adding/updating job |
string | |
project_id |
Foreign key of project for this job |
globally unique identifier |
Optionally required : project_id, project_reference_back_office or project must be provided |
project_reference_back_office |
Embedded entity "project" using ERP PK when adding/updating job |
string |
Optionally required : project_id, project_reference_back_office or project must be provided |
project |
Embedded entity "project" when adding/updating job |
project |
Optionally required : project_id, project_reference_back_office or project must be provided |
job_type_id |
Foreign key of job type for this job |
globally unique identifier |
Optionally required : job_type_id, job_type_code or job_type must be provided |
job_type_code |
Embedded entity "job_type" using ERP PK when adding/updating job |
string |
Optionally required : job_type_id, job_type_code or job_type must be provided |
job_type |
Embedded entity "job_type" when adding/updating job |
job_type |
Optionally required : job_type_id, job_type_code or job_type must be provided |
job_priority_id |
Foreign key of job priority for this job |
globally unique identifier | |
job_priority_code |
Foreign key of job status for this job. If you don't know the GUID, use job_type_code |
string | |
job_priority |
Embedded entity "job_priority" when adding/updating job |
job_priority | |
job_status_id |
Foreign key of job status for this job |
globally unique identifier |
Optionally required : job_status_id or job_status_code must be provided |
job_status_code |
Foreign key of job status using code. Use "Canceled,ToBePlanned, Waiting, Pooling, Suggested, Activated or Open" If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
string |
Optionally required : job_status_id or job_status_code must be provided |
db_address_id |
Foreign key of db_address if job is not on a mobile equipment.Must be the address_id of the location or the equipment |
globally unique identifier | |
contact_id |
Foreign key of contact if the main contact of the job is different than the one of the project |
globally unique identifier | |
requested_by_company_id |
Foreign key of company if a specific company makes the request for this job |
globally unique identifier | |
requested_by_contact_id |
Foreign key of contact to specify why contact of the requested_company_id makes the request |
globally unique identifier | |
reference_back_office |
The Id/Ref of the back office for this job. Used by Embedded entity |
string |
Max length: 50 |
name |
Name of the Job |
string |
Required Max length: 255 |
description |
Description of the job |
string |
Max length: 4000 |
working_sequence |
In case of mutli job, they will be ordered by this sequence |
integer | |
internal_memo |
Internal field for communication between BackOffice/Planners/Technicians |
string | |
prejob_information |
Information usefull for the technician before start (Call the customer,...) |
string | |
estimated_time |
Estimation of the time needed (in minute). Will be used for planning and statistic |
integer | |
earliest_date_plannable |
Use this field if there is a minimum date for the planning (Not Before) |
date | |
due_date |
Deadline of Max date for the planning (Not After) |
date | |
date_create |
Creation date+time |
date | |
date_update |
Update date+time |
date | |
date_closed |
Date+time job goes to completed |
date | |
suggested_user_id |
Foreign key of user if there is a suggested user (used for planning) If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
globally unique identifier | |
suggested_user_code |
Embedded entity "suggested user" using ERP PK when adding/updating job |
string | |
suggested_user |
Embedded entity "sugessted user" when adding/updating job |
user | |
suggested_date_start |
Suggested date+time start (used for planning) If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
date | |
skill_id |
Foreign key of skill if the job requires a specific skill (used for planning) |
globally unique identifier | |
skill_code |
Embedded entity "skill" using ERP PK when adding/updating job |
string | |
skill |
Embedded entity "skill" when adding/updating job |
skill | |
customer_reference |
Reference of this job for the customer |
string |
Max length: 50 |
approval_responsible_user_id |
In case of multi user job, foreign key of user that is the "WO Leader" |
globally unique identifier | |
date_reported_by_company |
Date+time when company reported the problem |
date | |
id2 |
Internal ID (numeric). Will be used if reference_back_office is empty |
integer | |
company_id |
This field will be filled automatically based on the project_id |
globally unique identifier | |
company_code |
This field will be filled automatically based on the project_id |
string | |
db_address_name |
When mobile equipment, the address to use |
string |
Max length: 100 |
db_address_street |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
db_address_street2 |
It is sub street |
string |
Max length: 50 |
db_address_street_number |
When mobile equipment, the address to use |
string |
Max length: 50 |
db_address_city |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
db_address_zip |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
db_address_db_country_id |
When mobile equipment, the address to use |
globally unique identifier | |
db_address_db_country_code |
When mobile equipment, the address to use |
string | |
db_address_phone |
When mobile equipment, the address to use |
string |
Max length: 50 |
db_address_email |
When mobile equipment, the address to use |
string |
Max length: 250 |
db_address_latitude_decimal |
Latitude |
decimal number | |
db_address_longitude_decimal |
Latitude |
decimal number | |
estimated_quantity_remark |
Description of the parts your technician should use or pick up |
string |
Max length: 4000 |
modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Request Formats :
application/json, text/json
{ "id": "5a0b615e-b09f-4af0-87b9-783054c49c21", "_parent_id": "fe22e082-cf5e-4db5-996a-34b1c3a3511a", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "be6cac47-e634-4ed0-9679-c6bd7b74d0aa", "project_reference_back_office": "sample string 5", "project": { "id": "62c69044-9eae-4d84-82da-9d2e00888c67", "_parent_id": "22d8fa04-3a35-4bfb-9ea6-dfb0ce623a20", "root_parent_id": "eaccb1d0-0930-4c8f-afb9-31217bc456b7", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "a39ca62b-fc54-4335-8893-e1b4ff342f26", "equipment_family_code": "sample string 6", "equipment_family": { "id": "68299e84-38f1-47f7-b109-bc7fd9fc17a7", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "5f1b0724-770f-4a54-9ae5-130abea1060e", "_parent_code": "sample string 6", "sales_organization_id": "42362f6c-31db-42c7-a702-b1c96a59cd53", "sales_organization_code": "sample string 8", "sales_organization": { "id": "609a04c2-8f06-4a0f-84d5-e0912efbcc7d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "18840445-ebee-4798-9621-1df9bbc914f7", "db_currency_id": "75639fe6-202e-4de1-af10-e0040270b9a0", "db_language_id": "31a4010f-1aea-4aa9-9f90-ff54c5ac5778", "accountancy_code": "sample string 8", "archived": true, "default_unit_of_measure_system_type": "sample string 10", "street": "sample string 11", "street2": "sample string 12", "street_number": "sample string 13", "zip": "sample string 14", "city": "sample string 15", "email": "sample string 16", "phone": "sample string 17", "fax": "sample string 18", "url": "sample string 19", "vat_reg_code": "sample string 20", "modified_dateutc": "2025-06-25T17:18:21.6986849+00:00" }, "modified_dateutc": "2025-06-25T17:18:21.6986849+00:00" }, "equipment_model_id": "642bbe04-4529-40e4-a383-9b3631a5216b", "equipment_model_code": "sample string 8", "equipment_model": { "id": "2e1e1325-fb83-4fb5-8c24-c8a2c5bf53da", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "deb6b5fb-77a7-4a4c-bc0d-e7c486268a4a", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "de1fd9c5-de4d-430f-9a90-7568565b33fe", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "97302f36-073e-461f-8226-af74d712ceca", "sales_organization_code": "sample string 5", "sales_organization": { "id": "609a04c2-8f06-4a0f-84d5-e0912efbcc7d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "18840445-ebee-4798-9621-1df9bbc914f7", "db_currency_id": "75639fe6-202e-4de1-af10-e0040270b9a0", "db_language_id": "31a4010f-1aea-4aa9-9f90-ff54c5ac5778", "accountancy_code": "sample string 8", "archived": true, "default_unit_of_measure_system_type": "sample string 10", "street": "sample string 11", "street2": "sample string 12", "street_number": "sample string 13", "zip": "sample string 14", "city": "sample string 15", "email": "sample string 16", "phone": "sample string 17", "fax": "sample string 18", "url": "sample string 19", "vat_reg_code": "sample string 20", "modified_dateutc": "2025-06-25T17:18:21.6986849+00:00" }, "modified_dateutc": "2025-06-25T17:18:21.6986849+00:00" }, "equipment_family_id": "c50401aa-ead3-44d9-8a98-87af78044031", "equipment_family_code": "sample string 8", "equipment_family": { "id": "68299e84-38f1-47f7-b109-bc7fd9fc17a7", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "5f1b0724-770f-4a54-9ae5-130abea1060e", "_parent_code": "sample string 6", "sales_organization_id": "42362f6c-31db-42c7-a702-b1c96a59cd53", "sales_organization_code": "sample string 8", "sales_organization": { "id": "609a04c2-8f06-4a0f-84d5-e0912efbcc7d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "18840445-ebee-4798-9621-1df9bbc914f7", "db_currency_id": "75639fe6-202e-4de1-af10-e0040270b9a0", "db_language_id": "31a4010f-1aea-4aa9-9f90-ff54c5ac5778", "accountancy_code": "sample string 8", "archived": true, "default_unit_of_measure_system_type": "sample string 10", "street": "sample string 11", "street2": "sample string 12", "street_number": "sample string 13", "zip": "sample string 14", "city": "sample string 15", "email": "sample string 16", "phone": "sample string 17", "fax": "sample string 18", "url": "sample string 19", "vat_reg_code": "sample string 20", "modified_dateutc": "2025-06-25T17:18:21.6986849+00:00" }, "modified_dateutc": "2025-06-25T17:18:21.6986849+00:00" }, "date_in_production_since": "2025-06-25T17:18:21.6986849+00:00", "date_out_of_production_since": "2025-06-25T17:18:21.6986849+00:00", "date_end_support": "2025-06-25T17:18:21.6986849+00:00", "sales_organization_id": "9ead944c-2ce1-4761-943a-9b03f6b5182c", "sales_organization_code": "sample string 13", "sales_organization": { "id": "609a04c2-8f06-4a0f-84d5-e0912efbcc7d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "18840445-ebee-4798-9621-1df9bbc914f7", "db_currency_id": "75639fe6-202e-4de1-af10-e0040270b9a0", "db_language_id": "31a4010f-1aea-4aa9-9f90-ff54c5ac5778", "accountancy_code": "sample string 8", "archived": true, "default_unit_of_measure_system_type": "sample string 10", "street": "sample string 11", "street2": "sample string 12", "street_number": "sample string 13", "zip": "sample string 14", "city": "sample string 15", "email": "sample string 16", "phone": "sample string 17", "fax": "sample string 18", "url": "sample string 19", "vat_reg_code": "sample string 20", "modified_dateutc": "2025-06-25T17:18:21.6986849+00:00" }, "replacement_period_nb_months": 14, "warranty_period_nb_months": 15, "translations": [ { "field_name": "sample string 1", "language_code": "sample string 2", "value_translated": "sample string 3" }, { "field_name": "sample string 1", "language_code": "sample string 2", "value_translated": "sample string 3" } ], "modified_dateutc": "2025-06-25T17:18:21.6986849+00:00" }, "project_status_id": "b2160447-379b-4e9b-b8fb-6a27bf31588a", "project_status_code": "sample string 10", "project_status": { "id": "2e53bfd8-2092-472d-a766-eeb1f5389140", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "730591f9-8cf6-4629-8ff9-f50e6a542abe", "sales_organization_code": "sample string 6", "sales_organization": { "id": "609a04c2-8f06-4a0f-84d5-e0912efbcc7d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "18840445-ebee-4798-9621-1df9bbc914f7", "db_currency_id": "75639fe6-202e-4de1-af10-e0040270b9a0", "db_language_id": "31a4010f-1aea-4aa9-9f90-ff54c5ac5778", "accountancy_code": "sample string 8", "archived": true, "default_unit_of_measure_system_type": "sample string 10", "street": "sample string 11", "street2": "sample string 12", "street_number": "sample string 13", "zip": "sample string 14", "city": "sample string 15", "email": "sample string 16", "phone": "sample string 17", "fax": "sample string 18", "url": "sample string 19", "vat_reg_code": "sample string 20", "modified_dateutc": "2025-06-25T17:18:21.6986849+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-06-25T17:18:21.6986849+00:00" }, "company_id": "47fcca11-77c7-4180-b966-a3a0519986d7", "company_code": "sample string 12", "db_address_id": "ab3810ae-5192-4f66-a7f9-1f28c7e4e0c8", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "6f3cc24c-485e-430c-b9eb-48cb8a1dbafa", "contact_reference_back_office": "sample string 17", "owner_user_id": "40547c40-8999-40ce-b9f3-ec5bcc13a212", "name": "sample string 19", "description": "sample string 20", "reference_back_office": "sample string 21", "serial_number": "sample string 22", "barcode": "sample string 23", "date_start_production": "2025-06-25T17:18:21.6986849+00:00", "date_create": "2025-06-25T17:18:21.6986849+00:00", "date_update": "2025-06-25T17:18:21.6986849+00:00", "updated_by_user_id": "883d6027-4341-446e-80f1-5a5696510208", "customer_reference": "sample string 28", "warranty_date_until": "2025-06-25T17:18:21.6986849+00:00", "last_standard_result_score_1": "sample string 30", "last_standard_result_score_2": "sample string 31", "target_standard_result_score_1": "sample string 32", "target_standard_result_score_2": "sample string 33", "date_built": "2025-06-25T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-06-25T17:18:21.6986849+00:00", "date_last_job": "2025-06-25T17:18:21.6986849+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-06-25T17:18:21.6986849+00:00", "modified_dateutc": "2025-06-25T17:18:21.6986849+00:00", "is_mobile_installation": true }, "job_type_id": "da6dab15-7aae-4197-811d-2857b5673089", "job_type_code": "sample string 7", "job_type": { "id": "7dcef147-5a01-42e7-89a7-856ddc195f89", "name": "sample string 2", "sales_organization_id": "a90562d2-7a95-42fa-ab15-ca4b34c92b5a", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-06-25T17:18:21.6986849+00:00", "code": "sample string 7" }, "job_priority_id": "0e642e23-e108-46ab-a67d-a495d6be1d6f", "job_priority_code": "sample string 9", "job_priority": { "id": "b0cfa838-2b6c-4f4f-bc6a-b662755ad768", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "c07826fb-fede-48a0-ad85-5834477140c4", "sales_organization_code": "sample string 6", "sales_organization": { "id": "609a04c2-8f06-4a0f-84d5-e0912efbcc7d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "18840445-ebee-4798-9621-1df9bbc914f7", "db_currency_id": "75639fe6-202e-4de1-af10-e0040270b9a0", "db_language_id": "31a4010f-1aea-4aa9-9f90-ff54c5ac5778", "accountancy_code": "sample string 8", "archived": true, "default_unit_of_measure_system_type": "sample string 10", "street": "sample string 11", "street2": "sample string 12", "street_number": "sample string 13", "zip": "sample string 14", "city": "sample string 15", "email": "sample string 16", "phone": "sample string 17", "fax": "sample string 18", "url": "sample string 19", "vat_reg_code": "sample string 20", "modified_dateutc": "2025-06-25T17:18:21.6986849+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-06-25T17:18:21.6986849+00:00" }, "job_status_id": "b53ca73b-09af-4f7a-b21a-db8a424d5dea", "job_status_code": "sample string 11", "db_address_id": "a1533852-76be-471b-95bc-26afe4d2c37a", "contact_id": "2492e325-a856-4ae0-aa52-c4fbfa5a106d", "requested_by_company_id": "43f4aa62-3074-4883-a461-b7e0dda19055", "requested_by_contact_id": "1c5b009e-7bdb-47e4-95c4-cbf6fe561ddd", "reference_back_office": "sample string 16", "name": "sample string 17", "description": "sample string 18", "working_sequence": 19, "internal_memo": "sample string 20", "prejob_information": "sample string 21", "estimated_time": 22, "earliest_date_plannable": "2025-06-25T17:18:21.6986849+00:00", "due_date": "2025-06-25T17:18:21.6986849+00:00", "date_create": "2025-06-25T17:18:21.6986849+00:00", "date_update": "2025-06-25T17:18:21.6986849+00:00", "date_closed": "2025-06-25T17:18:21.6986849+00:00", "suggested_user_id": "a7f1139d-5a15-4275-af4b-05b6d8c055f2", "suggested_user_code": "sample string 29", "suggested_user": { "id": "763ed03e-a2ff-4ade-a455-0194291b37f1", "db_language_id": "effc500d-6aa0-4194-ad7c-1e50287d2dd4", "username": "sample string 3", "firstname": "sample string 4", "lastname": "sample string 5", "code": "sample string 6", "archived": true, "disabled": true, "emergency_contact": "sample string 9", "bankaccount": "sample string 10", "social_security": "sample string 11", "place_of_birth": "sample string 12", "nationality": "sample string 13", "functions": "sample string 14", "birthdate": "2025-06-25T17:18:21.6986849+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "f675cc8d-d2ad-4ec4-a80a-6e03c8f52d81", "sales_organization": { "id": "609a04c2-8f06-4a0f-84d5-e0912efbcc7d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "18840445-ebee-4798-9621-1df9bbc914f7", "db_currency_id": "75639fe6-202e-4de1-af10-e0040270b9a0", "db_language_id": "31a4010f-1aea-4aa9-9f90-ff54c5ac5778", "accountancy_code": "sample string 8", "archived": true, "default_unit_of_measure_system_type": "sample string 10", "street": "sample string 11", "street2": "sample string 12", "street_number": "sample string 13", "zip": "sample string 14", "city": "sample string 15", "email": "sample string 16", "phone": "sample string 17", "fax": "sample string 18", "url": "sample string 19", "vat_reg_code": "sample string 20", "modified_dateutc": "2025-06-25T17:18:21.6986849+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "e87194a1-74b7-43b2-ac0f-1d478ea5c178", "email": "sample string 22", "phone": "sample string 23", "fax": "sample string 24", "mobile": "sample string 25", "private_email": "sample string 26", "private_phone": "sample string 27", "private_fax": "sample string 28", "private_mobile": "sample string 29", "private_street": "sample string 30", "private_street_number": "sample string 31", "private_city": "sample string 32", "private_zip": "sample string 33", "private_db_country_id": "50269e52-6083-4ae1-bc9d-6dfa4707dc56", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-06-25T17:18:21.6986849+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "6e527a5b-bae8-44b9-8810-99b4169e6178" }, "suggested_date_start": "2025-06-25T17:18:21.6986849+00:00", "skill_id": "e67d2451-017c-4e73-a23a-c42b4667bb68", "skill_code": "sample string 32", "skill": { "id": "c922275f-c9b6-46fd-bddf-606696170b4d", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "a0f3e1a7-6090-4f72-a29f-a230aef5ce53", "sales_organization_code": "sample string 6", "sales_organization": { "id": "609a04c2-8f06-4a0f-84d5-e0912efbcc7d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "18840445-ebee-4798-9621-1df9bbc914f7", "db_currency_id": "75639fe6-202e-4de1-af10-e0040270b9a0", "db_language_id": "31a4010f-1aea-4aa9-9f90-ff54c5ac5778", "accountancy_code": "sample string 8", "archived": true, "default_unit_of_measure_system_type": "sample string 10", "street": "sample string 11", "street2": "sample string 12", "street_number": "sample string 13", "zip": "sample string 14", "city": "sample string 15", "email": "sample string 16", "phone": "sample string 17", "fax": "sample string 18", "url": "sample string 19", "vat_reg_code": "sample string 20", "modified_dateutc": "2025-06-25T17:18:21.6986849+00:00" }, "modified_dateutc": "2025-06-25T17:18:21.6986849+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "819eb373-222b-4ffc-8e8e-b3925c031968", "date_reported_by_company": "2025-06-25T17:18:21.6986849+00:00", "id2": 36, "company_id": "7ce11e82-9f22-49d4-add6-b19a69819b7a", "company_code": "sample string 38", "db_address_name": "sample string 39", "db_address_street": "sample string 40", "db_address_street2": "sample string 41", "db_address_street_number": "sample string 42", "db_address_city": "sample string 43", "db_address_zip": "sample string 44", "db_address_db_country_id": "c8a47580-df66-4ed1-93f8-1dca95611e62", "db_address_db_country_code": "sample string 46", "db_address_phone": "sample string 47", "db_address_email": "sample string 48", "db_address_latitude_decimal": 49.0, "db_address_longitude_decimal": 50.0, "estimated_quantity_remark": "sample string 51", "modified_dateutc": "2025-06-25T17:18:21.6986849+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.