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": "8b0fede6-990c-49ff-8aea-12069cffcf7a", "_parent_id": "cf79c841-db67-43f2-a40e-d572572015a5", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "0121663f-f172-4bb1-8258-5f673505b6e5", "project_reference_back_office": "sample string 5", "project": { "id": "091fa46f-9761-4936-8db4-047f71551b64", "_parent_id": "80ed4fca-d5f3-4f67-b7e8-16977ae2e1c7", "root_parent_id": "c6cbe317-ad43-4995-826b-657cfaa6e46d", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "89f46ce4-f2cc-4e5b-8628-93d6a6e11ce5", "equipment_family_code": "sample string 6", "equipment_family": { "id": "89dec878-ebf2-4a91-a708-abc3e952858a", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "a444591a-66c9-4174-9160-36f6e83d9eee", "_parent_code": "sample string 6", "sales_organization_id": "f57bbd95-1ee8-4190-a9fd-9fad8ab775b4", "sales_organization_code": "sample string 8", "sales_organization": { "id": "ac5bcf43-9449-4967-a14a-19fc2f87cec5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2dfdf87a-600b-4870-aeca-6eb733274601", "db_currency_id": "358f3a27-dfd2-4709-8a44-938ad9e13039", "db_language_id": "2b62dba0-9c73-4a47-9033-0d5af9ffbb6a", "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-02-19T09:08:38.9937485+00:00" }, "modified_dateutc": "2025-02-19T09:08:38.9937485+00:00" }, "equipment_model_id": "717991dd-03b8-4cc0-8d8e-1679cf64bffe", "equipment_model_code": "sample string 8", "equipment_model": { "id": "0ba3cc8b-d851-4c69-a41f-824db71586ca", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "e11a099c-4f6a-43d8-81d6-8a2f2a1812c2", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "cec5b731-097f-419a-9ba2-71d902dae75a", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "c5c472f1-55cf-491b-a768-1574572cee65", "sales_organization_code": "sample string 5", "sales_organization": { "id": "ac5bcf43-9449-4967-a14a-19fc2f87cec5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2dfdf87a-600b-4870-aeca-6eb733274601", "db_currency_id": "358f3a27-dfd2-4709-8a44-938ad9e13039", "db_language_id": "2b62dba0-9c73-4a47-9033-0d5af9ffbb6a", "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-02-19T09:08:38.9937485+00:00" }, "modified_dateutc": "2025-02-19T09:08:38.9937485+00:00" }, "equipment_family_id": "1fb30ddd-1445-48a7-8587-237569f17f4b", "equipment_family_code": "sample string 8", "equipment_family": { "id": "89dec878-ebf2-4a91-a708-abc3e952858a", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "a444591a-66c9-4174-9160-36f6e83d9eee", "_parent_code": "sample string 6", "sales_organization_id": "f57bbd95-1ee8-4190-a9fd-9fad8ab775b4", "sales_organization_code": "sample string 8", "sales_organization": { "id": "ac5bcf43-9449-4967-a14a-19fc2f87cec5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2dfdf87a-600b-4870-aeca-6eb733274601", "db_currency_id": "358f3a27-dfd2-4709-8a44-938ad9e13039", "db_language_id": "2b62dba0-9c73-4a47-9033-0d5af9ffbb6a", "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-02-19T09:08:38.9937485+00:00" }, "modified_dateutc": "2025-02-19T09:08:38.9937485+00:00" }, "date_in_production_since": "2025-02-19T09:08:38.9937485+00:00", "date_out_of_production_since": "2025-02-19T09:08:38.9937485+00:00", "date_end_support": "2025-02-19T09:08:38.9937485+00:00", "sales_organization_id": "ab2d0386-0e89-43b6-b234-72488182b537", "sales_organization_code": "sample string 13", "sales_organization": { "id": "ac5bcf43-9449-4967-a14a-19fc2f87cec5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2dfdf87a-600b-4870-aeca-6eb733274601", "db_currency_id": "358f3a27-dfd2-4709-8a44-938ad9e13039", "db_language_id": "2b62dba0-9c73-4a47-9033-0d5af9ffbb6a", "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-02-19T09:08:38.9937485+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-02-19T09:08:38.9937485+00:00" }, "project_status_id": "10ed50ed-e179-4951-943c-811636bf1b09", "project_status_code": "sample string 10", "project_status": { "id": "6d8823d8-1499-49f5-b395-257b04ad0332", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "7d4da0e8-ade0-4210-be47-5e17e7e0216c", "sales_organization_code": "sample string 6", "sales_organization": { "id": "ac5bcf43-9449-4967-a14a-19fc2f87cec5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2dfdf87a-600b-4870-aeca-6eb733274601", "db_currency_id": "358f3a27-dfd2-4709-8a44-938ad9e13039", "db_language_id": "2b62dba0-9c73-4a47-9033-0d5af9ffbb6a", "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-02-19T09:08:38.9937485+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-02-19T09:08:38.9937485+00:00" }, "company_id": "50d2561e-a945-4c52-a156-980d77c39c29", "company_code": "sample string 12", "db_address_id": "e96f12f1-23fd-408b-949c-81790fe00fa7", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "b2ef7699-5a85-4b0a-86a7-f14e0682919f", "contact_reference_back_office": "sample string 17", "owner_user_id": "17147cf9-588f-4fea-87f2-c0e8fce44e9b", "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-02-19T09:08:38.9937485+00:00", "date_create": "2025-02-19T09:08:38.9937485+00:00", "date_update": "2025-02-19T09:08:38.9937485+00:00", "updated_by_user_id": "8648fcd9-0918-4311-a96c-555453833d1b", "customer_reference": "sample string 28", "warranty_date_until": "2025-02-19T09:08:38.9937485+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-02-19T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-02-19T09:08:38.9937485+00:00", "date_last_job": "2025-02-19T09:08:38.9937485+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-02-19T09:08:38.9937485+00:00", "modified_dateutc": "2025-02-19T09:08:38.9937485+00:00", "is_mobile_installation": true }, "job_type_id": "4e8bd652-1b58-40d6-9e45-e6e96d4eef5c", "job_type_code": "sample string 7", "job_type": { "id": "3927d9e8-aad4-4c78-b7db-4bf74403d0fc", "name": "sample string 2", "sales_organization_id": "21b925a3-09af-468c-adf0-980b35f84ecd", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-02-19T09:08:38.9937485+00:00", "code": "sample string 7" }, "job_priority_id": "4fb0ac49-6b8e-4907-b5cb-f40ca08f58aa", "job_priority_code": "sample string 9", "job_priority": { "id": "be217bfb-7f0e-4351-996c-86eec13fe10d", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "7673cdd6-83cc-4268-9ee6-13db6d1184c1", "sales_organization_code": "sample string 6", "sales_organization": { "id": "ac5bcf43-9449-4967-a14a-19fc2f87cec5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2dfdf87a-600b-4870-aeca-6eb733274601", "db_currency_id": "358f3a27-dfd2-4709-8a44-938ad9e13039", "db_language_id": "2b62dba0-9c73-4a47-9033-0d5af9ffbb6a", "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-02-19T09:08:38.9937485+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-02-19T09:08:38.9937485+00:00" }, "job_status_id": "9e8db33b-e779-475f-b7bc-6d3cde0cb9b9", "job_status_code": "sample string 11", "db_address_id": "6c5027f7-4ca2-4c1e-aa8b-b0dad2e040d4", "contact_id": "ac406383-04a2-4549-ab6f-85de8a1b0aa2", "requested_by_company_id": "af2c285c-9071-48af-9fc7-b4ecd5ab1906", "requested_by_contact_id": "6c26969b-6387-47ab-8996-cb2eacaeaca7", "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-02-19T09:08:38.9937485+00:00", "due_date": "2025-02-19T09:08:38.9937485+00:00", "date_create": "2025-02-19T09:08:38.9937485+00:00", "date_update": "2025-02-19T09:08:38.9937485+00:00", "date_closed": "2025-02-19T09:08:38.9937485+00:00", "suggested_user_id": "8f0e0b52-a24b-47da-b640-0c484ec858d5", "suggested_user_code": "sample string 29", "suggested_user": { "id": "36e75a2f-c3af-436f-8944-eeb7112b4e52", "db_language_id": "e5c4c381-4165-4ce5-be6b-60078fb7d602", "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-02-19T09:08:38.9937485+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "564fca2f-357b-4166-b390-8f7ba483ebb8", "sales_organization": { "id": "ac5bcf43-9449-4967-a14a-19fc2f87cec5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2dfdf87a-600b-4870-aeca-6eb733274601", "db_currency_id": "358f3a27-dfd2-4709-8a44-938ad9e13039", "db_language_id": "2b62dba0-9c73-4a47-9033-0d5af9ffbb6a", "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-02-19T09:08:38.9937485+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "841284df-d253-4b62-acc0-718af1ae470d", "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": "5da24b8b-9fc9-44a7-8c2f-e090e416d2f5", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-02-19T09:08:38.9937485+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "275f3180-a613-4ef3-a149-2451387d0169" }, "suggested_date_start": "2025-02-19T09:08:38.9937485+00:00", "skill_id": "84c6aa17-4e16-404a-803d-0109538a9b58", "skill_code": "sample string 32", "skill": { "id": "84e8a717-e6fd-4d95-ae00-e940025f1ea9", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "29d50267-cf04-4352-bd3b-bbb3a99215ab", "sales_organization_code": "sample string 6", "sales_organization": { "id": "ac5bcf43-9449-4967-a14a-19fc2f87cec5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2dfdf87a-600b-4870-aeca-6eb733274601", "db_currency_id": "358f3a27-dfd2-4709-8a44-938ad9e13039", "db_language_id": "2b62dba0-9c73-4a47-9033-0d5af9ffbb6a", "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-02-19T09:08:38.9937485+00:00" }, "modified_dateutc": "2025-02-19T09:08:38.9937485+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "1d4be25d-b83f-48da-958c-af781c81e0bd", "date_reported_by_company": "2025-02-19T09:08:38.9937485+00:00", "id2": 36, "company_id": "e11d9f9f-1f35-4a70-8a07-65e5dc70b69d", "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": "abeb1166-c382-4c5c-b760-836998d6140d", "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-02-19T09:08:38.9937485+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.