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": "a653ae6f-7bc6-45e7-99b3-d03a05ce770e", "_parent_id": "0cd7d1e2-c040-42ff-85d6-1997d9cce69f", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "313bbf81-f0e7-457e-bb5b-46489935fc33", "project_reference_back_office": "sample string 5", "project": { "id": "70b0240e-3ad3-42d9-b9e1-61b6d708ab21", "_parent_id": "b537e4ef-07e8-4dfb-ba45-7b8b88fcab36", "root_parent_id": "a1a213d4-64b7-4f27-aa0d-2c9040ce0205", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "8b5b4f71-fb32-4f5b-9c91-627686ec57d4", "equipment_family_code": "sample string 6", "equipment_family": { "id": "3295bfcd-3126-4012-a3c5-3a479f68e40d", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "71ccd91a-0aaa-48d9-854d-21cee95c68c3", "_parent_code": "sample string 6", "sales_organization_id": "3e6dac45-5022-4b4a-8d9d-27c4aea2a1fe", "sales_organization_code": "sample string 8", "sales_organization": { "id": "1c06d0ff-2b33-4a37-85e2-841ffcb1377e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a3197d11-b2b6-4587-9b3b-d961e9a44059", "db_currency_id": "0363cf20-3f98-40d5-af29-da59865531dd", "db_language_id": "3c697c6e-11dc-450d-a7a6-c83d14486f16", "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-03-28T13:31:41.4333148+00:00" }, "modified_dateutc": "2025-03-28T13:31:41.4333148+00:00" }, "equipment_model_id": "4923e847-b154-4737-9da0-170ce3e77dc8", "equipment_model_code": "sample string 8", "equipment_model": { "id": "391651f7-28e7-4fa5-8d94-2152617eb7af", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "51fbbfee-3090-446b-9a0f-ad19dcad3460", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "9b562d34-00e5-48f5-82a6-6a003ad2b4c2", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "10b934ea-c042-4679-b996-2fb541701b08", "sales_organization_code": "sample string 5", "sales_organization": { "id": "1c06d0ff-2b33-4a37-85e2-841ffcb1377e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a3197d11-b2b6-4587-9b3b-d961e9a44059", "db_currency_id": "0363cf20-3f98-40d5-af29-da59865531dd", "db_language_id": "3c697c6e-11dc-450d-a7a6-c83d14486f16", "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-03-28T13:31:41.4333148+00:00" }, "modified_dateutc": "2025-03-28T13:31:41.4333148+00:00" }, "equipment_family_id": "83cd5e72-2a49-4ef8-96e3-8e894717ca68", "equipment_family_code": "sample string 8", "equipment_family": { "id": "3295bfcd-3126-4012-a3c5-3a479f68e40d", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "71ccd91a-0aaa-48d9-854d-21cee95c68c3", "_parent_code": "sample string 6", "sales_organization_id": "3e6dac45-5022-4b4a-8d9d-27c4aea2a1fe", "sales_organization_code": "sample string 8", "sales_organization": { "id": "1c06d0ff-2b33-4a37-85e2-841ffcb1377e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a3197d11-b2b6-4587-9b3b-d961e9a44059", "db_currency_id": "0363cf20-3f98-40d5-af29-da59865531dd", "db_language_id": "3c697c6e-11dc-450d-a7a6-c83d14486f16", "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-03-28T13:31:41.4333148+00:00" }, "modified_dateutc": "2025-03-28T13:31:41.4333148+00:00" }, "date_in_production_since": "2025-03-28T13:31:41.4333148+00:00", "date_out_of_production_since": "2025-03-28T13:31:41.4333148+00:00", "date_end_support": "2025-03-28T13:31:41.4333148+00:00", "sales_organization_id": "bf308f4d-4c6f-4078-8c72-dd3d2ea2ec6a", "sales_organization_code": "sample string 13", "sales_organization": { "id": "1c06d0ff-2b33-4a37-85e2-841ffcb1377e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a3197d11-b2b6-4587-9b3b-d961e9a44059", "db_currency_id": "0363cf20-3f98-40d5-af29-da59865531dd", "db_language_id": "3c697c6e-11dc-450d-a7a6-c83d14486f16", "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-03-28T13:31:41.4333148+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-03-28T13:31:41.4333148+00:00" }, "project_status_id": "3f35985b-7e46-4fed-8e9d-b3b92d89fd62", "project_status_code": "sample string 10", "project_status": { "id": "a6773840-3dfa-4fb7-928f-e7f60a46692d", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "e8a0f54d-dc4e-4ef1-bd06-cf3f37c78859", "sales_organization_code": "sample string 6", "sales_organization": { "id": "1c06d0ff-2b33-4a37-85e2-841ffcb1377e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a3197d11-b2b6-4587-9b3b-d961e9a44059", "db_currency_id": "0363cf20-3f98-40d5-af29-da59865531dd", "db_language_id": "3c697c6e-11dc-450d-a7a6-c83d14486f16", "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-03-28T13:31:41.4333148+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-03-28T13:31:41.4333148+00:00" }, "company_id": "fe850d5f-2dd1-4a05-8b13-0b9141072a66", "company_code": "sample string 12", "db_address_id": "0bf4dc6a-4153-4dfc-a926-294c39d7877d", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "9aa8a9dc-93ee-4a5d-8a15-d4198ee9b643", "contact_reference_back_office": "sample string 17", "owner_user_id": "9fd7fe88-5e38-4c7e-81f0-8cf0443bda7e", "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-03-28T13:31:41.4333148+00:00", "date_create": "2025-03-28T13:31:41.4333148+00:00", "date_update": "2025-03-28T13:31:41.4333148+00:00", "updated_by_user_id": "0f61a38f-a336-4991-9ccd-edd323016b34", "customer_reference": "sample string 28", "warranty_date_until": "2025-03-28T13:31:41.4333148+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-03-28T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-03-28T13:31:41.4333148+00:00", "date_last_job": "2025-03-28T13:31:41.4333148+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-03-28T13:31:41.4333148+00:00", "modified_dateutc": "2025-03-28T13:31:41.4333148+00:00", "is_mobile_installation": true }, "job_type_id": "947f684b-8a75-4aae-b1d5-d95069c7c454", "job_type_code": "sample string 7", "job_type": { "id": "b9f24cb6-45b9-4afb-bc00-005fea529acd", "name": "sample string 2", "sales_organization_id": "ae4c63c8-9804-47be-8a04-313583f8fa1c", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-03-28T13:31:41.4333148+00:00", "code": "sample string 7" }, "job_priority_id": "9a1a0690-3152-458e-ab19-693204405781", "job_priority_code": "sample string 9", "job_priority": { "id": "8960cceb-7115-486c-9ec0-d4423275c305", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "d6fccbb3-3c9a-43e9-9c01-48629a9b3360", "sales_organization_code": "sample string 6", "sales_organization": { "id": "1c06d0ff-2b33-4a37-85e2-841ffcb1377e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a3197d11-b2b6-4587-9b3b-d961e9a44059", "db_currency_id": "0363cf20-3f98-40d5-af29-da59865531dd", "db_language_id": "3c697c6e-11dc-450d-a7a6-c83d14486f16", "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-03-28T13:31:41.4333148+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-03-28T13:31:41.4333148+00:00" }, "job_status_id": "259ff028-ac00-4e9a-bda1-89ee237001d7", "job_status_code": "sample string 11", "db_address_id": "51f98be5-3015-4f84-ae70-7795070efb3a", "contact_id": "5abc05e8-7ca1-4295-87f3-e3fe114dc1e8", "requested_by_company_id": "5f1bfb41-32b3-4647-ba35-0b083ac53e1a", "requested_by_contact_id": "09a745e2-5d18-45b9-bf2f-4ee38cc6dd7e", "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-03-28T13:31:41.4333148+00:00", "due_date": "2025-03-28T13:31:41.4333148+00:00", "date_create": "2025-03-28T13:31:41.4333148+00:00", "date_update": "2025-03-28T13:31:41.4333148+00:00", "date_closed": "2025-03-28T13:31:41.4333148+00:00", "suggested_user_id": "1c007b6c-3f0f-4ba4-8288-bd57b1fd3cd4", "suggested_user_code": "sample string 29", "suggested_user": { "id": "cbd02f45-87f2-419a-b026-aed2b4f73d9b", "db_language_id": "39209b79-bcb0-4d25-9645-37617094827f", "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-03-28T13:31:41.4333148+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "7658db6d-2d00-40c5-9f78-251a92513ee9", "sales_organization": { "id": "1c06d0ff-2b33-4a37-85e2-841ffcb1377e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a3197d11-b2b6-4587-9b3b-d961e9a44059", "db_currency_id": "0363cf20-3f98-40d5-af29-da59865531dd", "db_language_id": "3c697c6e-11dc-450d-a7a6-c83d14486f16", "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-03-28T13:31:41.4333148+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "c4e64cf8-6f8a-4e82-8408-f895f462cc71", "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": "47fc1744-260f-4665-bba3-ee7103b99fad", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-03-28T13:31:41.4333148+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "b411a2d8-ce8e-4f58-8161-728b794ffe1c" }, "suggested_date_start": "2025-03-28T13:31:41.4333148+00:00", "skill_id": "72e25869-5496-4dda-b8ab-f75988982979", "skill_code": "sample string 32", "skill": { "id": "01b6d52d-227a-4af5-a980-3b6e33acdf30", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "cd03ac83-bc1f-4039-8492-660c4ded559c", "sales_organization_code": "sample string 6", "sales_organization": { "id": "1c06d0ff-2b33-4a37-85e2-841ffcb1377e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a3197d11-b2b6-4587-9b3b-d961e9a44059", "db_currency_id": "0363cf20-3f98-40d5-af29-da59865531dd", "db_language_id": "3c697c6e-11dc-450d-a7a6-c83d14486f16", "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-03-28T13:31:41.4333148+00:00" }, "modified_dateutc": "2025-03-28T13:31:41.4333148+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "3083437e-6143-4d16-ace2-5a62a81c19fe", "date_reported_by_company": "2025-03-28T13:31:41.4333148+00:00", "id2": 36, "company_id": "00f5839e-712d-4650-834d-a1d0e4874b8d", "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": "d35daece-9415-414f-ab0b-f8d90cdad328", "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-03-28T13:31:41.4333148+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.