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": "795fbbef-71bb-41a5-a250-dada8b46f38a", "_parent_id": "7825dff0-8697-4343-bdcc-75b5b899f69f", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "9618b6e5-3b2f-4d0a-9a39-7e0790bd83cf", "project_reference_back_office": "sample string 5", "project": { "id": "1dee39b6-7b92-4381-a287-efd2998f3d01", "_parent_id": "81085335-26fe-4a38-be88-5f9ee4d48b1d", "root_parent_id": "39efcdda-84b3-4d06-9e0a-241e47ad400f", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "d5bbc0f0-62eb-4e3a-aa35-506af3dd9a6b", "equipment_family_code": "sample string 6", "equipment_family": { "id": "d4581f98-7137-4703-96fb-f6e5b891fed7", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "d3e6e0fd-4294-4041-bb03-678cd4dd9f6a", "_parent_code": "sample string 6", "sales_organization_id": "aca1baa9-6a2c-4dad-9e68-292fe6c63b10", "sales_organization_code": "sample string 8", "sales_organization": { "id": "e037ad0b-034a-4e41-a433-f68263c41c6b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c3762190-c777-43bb-8e61-02aedeaa1361", "db_currency_id": "c2e5e756-aaf8-4d6b-b261-7d82073968c6", "db_language_id": "336a6831-b87d-4276-a3ca-9d3fda81b125", "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-04-02T00:41:21.8139949+00:00" }, "modified_dateutc": "2025-04-02T00:41:21.8139949+00:00" }, "equipment_model_id": "200d8a31-231a-4353-87db-a7652d3b2e07", "equipment_model_code": "sample string 8", "equipment_model": { "id": "856eba10-9245-48bb-a813-9824e6e485a9", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "4ac30d7d-50ca-4030-9a9e-9ea95116fa0e", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "6bf5b320-73eb-40d7-a53d-746bf14ec565", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "55dd0b47-62be-4ce6-96e1-7ffcf3008c15", "sales_organization_code": "sample string 5", "sales_organization": { "id": "e037ad0b-034a-4e41-a433-f68263c41c6b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c3762190-c777-43bb-8e61-02aedeaa1361", "db_currency_id": "c2e5e756-aaf8-4d6b-b261-7d82073968c6", "db_language_id": "336a6831-b87d-4276-a3ca-9d3fda81b125", "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-04-02T00:41:21.8139949+00:00" }, "modified_dateutc": "2025-04-02T00:41:21.8139949+00:00" }, "equipment_family_id": "7734edae-245d-462f-9900-ad44f2e5522f", "equipment_family_code": "sample string 8", "equipment_family": { "id": "d4581f98-7137-4703-96fb-f6e5b891fed7", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "d3e6e0fd-4294-4041-bb03-678cd4dd9f6a", "_parent_code": "sample string 6", "sales_organization_id": "aca1baa9-6a2c-4dad-9e68-292fe6c63b10", "sales_organization_code": "sample string 8", "sales_organization": { "id": "e037ad0b-034a-4e41-a433-f68263c41c6b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c3762190-c777-43bb-8e61-02aedeaa1361", "db_currency_id": "c2e5e756-aaf8-4d6b-b261-7d82073968c6", "db_language_id": "336a6831-b87d-4276-a3ca-9d3fda81b125", "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-04-02T00:41:21.8139949+00:00" }, "modified_dateutc": "2025-04-02T00:41:21.8139949+00:00" }, "date_in_production_since": "2025-04-02T00:41:21.8139949+00:00", "date_out_of_production_since": "2025-04-02T00:41:21.8139949+00:00", "date_end_support": "2025-04-02T00:41:21.8139949+00:00", "sales_organization_id": "a62eeeae-00e2-4e8e-9b39-743cd63d9a93", "sales_organization_code": "sample string 13", "sales_organization": { "id": "e037ad0b-034a-4e41-a433-f68263c41c6b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c3762190-c777-43bb-8e61-02aedeaa1361", "db_currency_id": "c2e5e756-aaf8-4d6b-b261-7d82073968c6", "db_language_id": "336a6831-b87d-4276-a3ca-9d3fda81b125", "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-04-02T00:41:21.8139949+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-04-02T00:41:21.8139949+00:00" }, "project_status_id": "e3a1692b-02ab-4387-95d8-c1f3c51fa3dd", "project_status_code": "sample string 10", "project_status": { "id": "84fc57f6-7c0d-4344-aa32-8ffe43fede41", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "3f065822-ae49-4db7-a7eb-2854d3c16146", "sales_organization_code": "sample string 6", "sales_organization": { "id": "e037ad0b-034a-4e41-a433-f68263c41c6b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c3762190-c777-43bb-8e61-02aedeaa1361", "db_currency_id": "c2e5e756-aaf8-4d6b-b261-7d82073968c6", "db_language_id": "336a6831-b87d-4276-a3ca-9d3fda81b125", "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-04-02T00:41:21.8139949+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-04-02T00:41:21.8139949+00:00" }, "company_id": "c185f55b-1258-4959-b148-6194c8d0ade1", "company_code": "sample string 12", "db_address_id": "d01438ff-4a18-4ebb-a4b1-b4f39a1cd66a", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "80f218d3-f143-4187-a145-2c64fb96c3c3", "contact_reference_back_office": "sample string 17", "owner_user_id": "71316870-abe2-4473-9b4c-51f0f968d72d", "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-04-02T00:41:21.8139949+00:00", "date_create": "2025-04-02T00:41:21.8139949+00:00", "date_update": "2025-04-02T00:41:21.8139949+00:00", "updated_by_user_id": "bd5cb95e-9c34-4322-9e02-ba1c4ef24d79", "customer_reference": "sample string 28", "warranty_date_until": "2025-04-02T00:41:21.8139949+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-04-02T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-04-02T00:41:21.8139949+00:00", "date_last_job": "2025-04-02T00:41:21.8139949+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-04-02T00:41:21.8139949+00:00", "modified_dateutc": "2025-04-02T00:41:21.8139949+00:00", "is_mobile_installation": true }, "job_type_id": "8edcfbe1-ca88-4d60-8a46-ce2cbadb216a", "job_type_code": "sample string 7", "job_type": { "id": "dc660c0b-9c88-47d5-9fc8-0b0f06253640", "name": "sample string 2", "sales_organization_id": "d8543cea-ce19-416d-85cd-a8ac3dc2085b", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-04-02T00:41:21.8139949+00:00", "code": "sample string 7" }, "job_priority_id": "b08d753b-dab1-47f7-a73a-52e8bb28308c", "job_priority_code": "sample string 9", "job_priority": { "id": "ea317da7-cd68-4e11-b798-35c58b8c9178", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "743c9908-e9a1-4e01-9e71-76fd2fed243f", "sales_organization_code": "sample string 6", "sales_organization": { "id": "e037ad0b-034a-4e41-a433-f68263c41c6b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c3762190-c777-43bb-8e61-02aedeaa1361", "db_currency_id": "c2e5e756-aaf8-4d6b-b261-7d82073968c6", "db_language_id": "336a6831-b87d-4276-a3ca-9d3fda81b125", "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-04-02T00:41:21.8139949+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-04-02T00:41:21.8139949+00:00" }, "job_status_id": "811743af-3f01-4928-8081-b6ee76db81cb", "job_status_code": "sample string 11", "db_address_id": "96311ad5-e92b-45d2-ae97-fc1a8e444062", "contact_id": "7c4c7c41-7fec-4edf-821e-7f8215b37465", "requested_by_company_id": "37891c6d-22e6-4e6d-854f-d6e77de7c2e5", "requested_by_contact_id": "6763955a-a0c7-4297-8524-c8393cd70b8a", "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-04-02T00:41:21.8139949+00:00", "due_date": "2025-04-02T00:41:21.8139949+00:00", "date_create": "2025-04-02T00:41:21.8139949+00:00", "date_update": "2025-04-02T00:41:21.8139949+00:00", "date_closed": "2025-04-02T00:41:21.8139949+00:00", "suggested_user_id": "b262c843-4c02-4791-b9a2-5df1d2da4fcb", "suggested_user_code": "sample string 29", "suggested_user": { "id": "8c4b3dce-02aa-4edb-8911-ccedd5f48b51", "db_language_id": "b9ee1c08-d6d4-4ca5-a768-8588eb6ded0c", "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-04-02T00:41:21.8139949+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "931b7e88-0e92-48ab-a7e7-03d709d96b45", "sales_organization": { "id": "e037ad0b-034a-4e41-a433-f68263c41c6b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c3762190-c777-43bb-8e61-02aedeaa1361", "db_currency_id": "c2e5e756-aaf8-4d6b-b261-7d82073968c6", "db_language_id": "336a6831-b87d-4276-a3ca-9d3fda81b125", "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-04-02T00:41:21.8139949+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "89a2ea08-4fa8-4fbc-bdc5-a4a9ae6c594f", "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": "dc388680-8413-48f7-b312-15157dacf2df", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-04-02T00:41:21.8139949+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "370f0856-2fbc-4d5b-9e8f-1fa36a8aed18" }, "suggested_date_start": "2025-04-02T00:41:21.8139949+00:00", "skill_id": "0c184776-2acf-42c3-9372-e75159ea8630", "skill_code": "sample string 32", "skill": { "id": "8b63410c-48be-405e-ae13-42c03b020529", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "da022d80-396b-4e22-94fd-42f864252748", "sales_organization_code": "sample string 6", "sales_organization": { "id": "e037ad0b-034a-4e41-a433-f68263c41c6b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c3762190-c777-43bb-8e61-02aedeaa1361", "db_currency_id": "c2e5e756-aaf8-4d6b-b261-7d82073968c6", "db_language_id": "336a6831-b87d-4276-a3ca-9d3fda81b125", "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-04-02T00:41:21.8139949+00:00" }, "modified_dateutc": "2025-04-02T00:41:21.8139949+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "81baead6-a1ee-46fd-806b-65e4a3b72540", "date_reported_by_company": "2025-04-02T00:41:21.8139949+00:00", "id2": 36, "company_id": "b6887cf0-9256-4eb8-99de-ae924a4596d0", "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": "23c46c18-73a8-4346-8eca-7bfb4b9f5a9d", "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-04-02T00:41:21.8139949+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.