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": "e4cfb263-cca3-4a1a-8f4a-2783b096c017", "_parent_id": "7c7b5901-6050-40b9-86f7-1713a0091a4a", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "c096a519-626e-4336-96e9-2f2bf900965b", "project_reference_back_office": "sample string 5", "project": { "id": "b2933cd4-70a9-4177-8dc9-1b0cf2c4755e", "_parent_id": "88e0e2b3-9077-496c-b542-bf468520dc6c", "root_parent_id": "18df919a-2042-4cad-96dd-da6f0690facd", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "d2865fb6-6a1c-4156-93c7-ec896deb4a04", "equipment_family_code": "sample string 6", "equipment_family": { "id": "ad075ee4-5a59-43c2-a3e3-77d63a64252d", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "4656b8c4-68ee-4cfd-abd5-64f8d6da66ad", "_parent_code": "sample string 6", "sales_organization_id": "023fd375-047a-4a75-bd8d-58304ce5bd72", "sales_organization_code": "sample string 8", "sales_organization": { "id": "c381efd7-f293-41ed-b2eb-ea975fd6c13f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1068dbf6-797b-4a26-accd-4509e8377dc0", "db_currency_id": "2e3fefc5-8b26-4fea-8254-09b572b6f60d", "db_language_id": "3fe53c58-fbeb-47fe-86b5-4915897a3ef7", "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": "2023-03-30T21:47:06.3820596+00:00" }, "modified_dateutc": "2023-03-30T21:47:06.3820596+00:00" }, "equipment_model_id": "619efaca-e202-4a3f-81f9-1e5acf4083c3", "equipment_model_code": "sample string 8", "equipment_model": { "id": "b872d89b-4670-4025-86b4-9181eeda5f89", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "e3f21f4c-dc07-44f0-bf29-6f921974c64b", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "851b2a33-29b4-4893-893b-764e300d3fb1", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "3c8e6048-d6c2-478f-bc53-4ff1a71839fb", "sales_organization_code": "sample string 5", "sales_organization": { "id": "c381efd7-f293-41ed-b2eb-ea975fd6c13f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1068dbf6-797b-4a26-accd-4509e8377dc0", "db_currency_id": "2e3fefc5-8b26-4fea-8254-09b572b6f60d", "db_language_id": "3fe53c58-fbeb-47fe-86b5-4915897a3ef7", "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": "2023-03-30T21:47:06.3820596+00:00" }, "modified_dateutc": "2023-03-30T21:47:06.3820596+00:00" }, "equipment_family_id": "e11a5c73-afeb-432d-8d3d-3149c1d7adf5", "equipment_family_code": "sample string 8", "equipment_family": { "id": "ad075ee4-5a59-43c2-a3e3-77d63a64252d", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "4656b8c4-68ee-4cfd-abd5-64f8d6da66ad", "_parent_code": "sample string 6", "sales_organization_id": "023fd375-047a-4a75-bd8d-58304ce5bd72", "sales_organization_code": "sample string 8", "sales_organization": { "id": "c381efd7-f293-41ed-b2eb-ea975fd6c13f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1068dbf6-797b-4a26-accd-4509e8377dc0", "db_currency_id": "2e3fefc5-8b26-4fea-8254-09b572b6f60d", "db_language_id": "3fe53c58-fbeb-47fe-86b5-4915897a3ef7", "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": "2023-03-30T21:47:06.3820596+00:00" }, "modified_dateutc": "2023-03-30T21:47:06.3820596+00:00" }, "date_in_production_since": "2023-03-30T21:47:06.3820596+00:00", "date_out_of_production_since": "2023-03-30T21:47:06.3820596+00:00", "date_end_support": "2023-03-30T21:47:06.3820596+00:00", "sales_organization_id": "de233506-53f6-44c2-a196-a81d032a734b", "sales_organization_code": "sample string 13", "sales_organization": { "id": "c381efd7-f293-41ed-b2eb-ea975fd6c13f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1068dbf6-797b-4a26-accd-4509e8377dc0", "db_currency_id": "2e3fefc5-8b26-4fea-8254-09b572b6f60d", "db_language_id": "3fe53c58-fbeb-47fe-86b5-4915897a3ef7", "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": "2023-03-30T21:47:06.3820596+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": "2023-03-30T21:47:06.3820596+00:00" }, "project_status_id": "f5870205-14bd-4145-8319-54869df95847", "project_status_code": "sample string 10", "project_status": { "id": "bb101668-f692-4c7f-8383-b230914d5a14", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "25070366-00b1-4654-8171-4e013db1f968", "sales_organization_code": "sample string 6", "sales_organization": { "id": "c381efd7-f293-41ed-b2eb-ea975fd6c13f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1068dbf6-797b-4a26-accd-4509e8377dc0", "db_currency_id": "2e3fefc5-8b26-4fea-8254-09b572b6f60d", "db_language_id": "3fe53c58-fbeb-47fe-86b5-4915897a3ef7", "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": "2023-03-30T21:47:06.3820596+00:00" }, "code": "sample string 7", "modified_dateutc": "2023-03-30T21:47:06.3820596+00:00" }, "company_id": "9a43878b-f751-4417-8eb0-1d374e6dc434", "company_code": "sample string 12", "db_address_id": "d6184bd9-7b9f-42d0-ac02-d57afd9501c0", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "8f054f56-c97f-4c35-9656-f2fb12a5ec7f", "contact_reference_back_office": "sample string 17", "owner_user_id": "0dff42ee-f6cc-4952-8a34-e3b5e7820212", "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": "2023-03-30T21:47:06.3820596+00:00", "date_create": "2023-03-30T21:47:06.3820596+00:00", "date_update": "2023-03-30T21:47:06.3820596+00:00", "updated_by_user_id": "672058b4-0f34-4c21-9838-7d6e00d62c24", "customer_reference": "sample string 28", "warranty_date_until": "2023-03-30T21:47:06.3820596+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": "2023-03-30T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2023-03-30T21:47:06.3820596+00:00", "date_last_job": "2023-03-30T21:47:06.3820596+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2023-03-30T21:47:06.3820596+00:00", "modified_dateutc": "2023-03-30T21:47:06.3820596+00:00", "is_mobile_installation": true }, "job_type_id": "197ee34a-9ecc-4905-b575-7c915b4f216d", "job_type_code": "sample string 7", "job_type": { "id": "5325d34e-2557-46b9-8b36-397b8cb2997e", "name": "sample string 2", "sales_organization_id": "cf335c03-f3d5-4c9c-9aed-bc55873c76ce", "description": "sample string 4", "is_default": true, "modified_dateutc": "2023-03-30T21:47:06.3820596+00:00", "code": "sample string 7" }, "job_priority_id": "3d91dd42-338a-44fe-8245-8c8a58a2ce60", "job_priority_code": "sample string 9", "job_priority": { "id": "27093d89-2cb3-41a4-a766-1bd0ac26709f", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "e0f25ad2-cb03-4657-98f0-3d04159419ea", "sales_organization_code": "sample string 6", "sales_organization": { "id": "c381efd7-f293-41ed-b2eb-ea975fd6c13f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1068dbf6-797b-4a26-accd-4509e8377dc0", "db_currency_id": "2e3fefc5-8b26-4fea-8254-09b572b6f60d", "db_language_id": "3fe53c58-fbeb-47fe-86b5-4915897a3ef7", "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": "2023-03-30T21:47:06.3820596+00:00" }, "code": "sample string 7", "modified_dateutc": "2023-03-30T21:47:06.3820596+00:00" }, "job_status_id": "03d0c8b6-14ec-4401-a8b1-084f94c526d8", "job_status_code": "sample string 11", "db_address_id": "fbca7827-456d-47fe-b5b1-182f3a6ff6d8", "contact_id": "1a06223d-cdd6-4e32-8461-d126d6e28a7b", "requested_by_company_id": "7e2b6ee2-9517-4554-b842-6a85d9a5c197", "requested_by_contact_id": "70842cf5-ce80-44b9-9bb1-030923c8c271", "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": "2023-03-30T21:47:06.3820596+00:00", "due_date": "2023-03-30T21:47:06.3820596+00:00", "date_create": "2023-03-30T21:47:06.3820596+00:00", "date_update": "2023-03-30T21:47:06.3820596+00:00", "date_closed": "2023-03-30T21:47:06.3820596+00:00", "suggested_user_id": "6d8e1796-832a-48d7-a3d7-40c1da39d3a2", "suggested_user_code": "sample string 29", "suggested_user": { "id": "bd39e567-7cf2-44e4-b3a9-3225618073b4", "db_language_id": "98acf771-62a3-4bb9-803c-d13e5381d3be", "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": "2023-03-30T21:47:06.3820596+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "90a4225f-0939-4253-82a6-caa049b0133b", "sales_organization": { "id": "c381efd7-f293-41ed-b2eb-ea975fd6c13f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1068dbf6-797b-4a26-accd-4509e8377dc0", "db_currency_id": "2e3fefc5-8b26-4fea-8254-09b572b6f60d", "db_language_id": "3fe53c58-fbeb-47fe-86b5-4915897a3ef7", "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": "2023-03-30T21:47:06.3820596+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "3daa69bc-6fd0-457b-bd46-a1469a798333", "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": "262d4978-a21a-4914-933f-58fde520ff19", "private_db_country_code": "sample string 35", "modified_dateutc": "2023-03-30T21:47:06.3820596+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "bcacb6b0-ab03-4c3a-8d25-e05a59ac8385" }, "suggested_date_start": "2023-03-30T21:47:06.3820596+00:00", "skill_id": "68d382f4-e676-4efe-82be-86742161426a", "skill_code": "sample string 32", "skill": { "id": "51d3e773-bc81-43b5-b87f-25f0baa3ab7d", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "4e675469-e292-4656-98df-cb821cb4e411", "sales_organization_code": "sample string 6", "sales_organization": { "id": "c381efd7-f293-41ed-b2eb-ea975fd6c13f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1068dbf6-797b-4a26-accd-4509e8377dc0", "db_currency_id": "2e3fefc5-8b26-4fea-8254-09b572b6f60d", "db_language_id": "3fe53c58-fbeb-47fe-86b5-4915897a3ef7", "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": "2023-03-30T21:47:06.3820596+00:00" }, "modified_dateutc": "2023-03-30T21:47:06.3820596+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "fb6af225-0dc9-4d77-895b-35cab23c1c5b", "date_reported_by_company": "2023-03-30T21:47:06.3820596+00:00", "id2": 36, "company_id": "278a49a2-49b6-4c13-8a09-cb742bf49207", "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": "acef61f9-5db4-41d1-a8fd-5a30354ea36f", "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": "2023-03-30T21:47:06.3820596+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.