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": "0aac72d0-6344-41de-97c8-7deece58184d", "_parent_id": "0f5444bc-8a5d-435c-b809-6e6a640b3b28", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "51d2f793-12ea-40a0-bc1d-2eb210c6f82c", "project_reference_back_office": "sample string 5", "project": { "id": "bb29d106-08e1-49a1-b525-36789deabc7e", "_parent_id": "8ae3d599-c886-432b-b507-24294d5364b8", "root_parent_id": "02c42f48-ce82-47c6-8c10-903f4903a57d", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "e1627750-a67f-48f7-81b1-fe4105768b52", "equipment_family_code": "sample string 6", "equipment_family": { "id": "36570982-03db-4725-b19b-433aae63dd82", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "67183f43-0898-4976-8fbb-f611b28d3c46", "_parent_code": "sample string 6", "sales_organization_id": "205417bd-8836-4011-a3fc-e24868b20374", "sales_organization_code": "sample string 8", "sales_organization": { "id": "c348e2af-3599-49fa-a8a4-f6a7a15ef4ce", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "976bc64c-ce9b-49d4-8162-3988e4db655c", "db_currency_id": "3bc1908d-3338-49ed-9e35-f5479ffb33d4", "db_language_id": "762d7662-9617-4646-a34a-d2e57f834da9", "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-31T21:59:31.0966901+00:00" }, "modified_dateutc": "2023-03-31T21:59:31.1123132+00:00" }, "equipment_model_id": "5d79c3f7-93f8-40d2-a9a5-e3fa35b2cc5b", "equipment_model_code": "sample string 8", "equipment_model": { "id": "83a31825-4462-47b9-9cf7-71755313d675", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "062e4e08-e549-481e-8445-753f766a1f46", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "3d0585d8-b177-497d-830e-c5776fc86d3d", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "b5556229-3057-46fe-98e7-4da2e4437ba1", "sales_organization_code": "sample string 5", "sales_organization": { "id": "c348e2af-3599-49fa-a8a4-f6a7a15ef4ce", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "976bc64c-ce9b-49d4-8162-3988e4db655c", "db_currency_id": "3bc1908d-3338-49ed-9e35-f5479ffb33d4", "db_language_id": "762d7662-9617-4646-a34a-d2e57f834da9", "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-31T21:59:31.0966901+00:00" }, "modified_dateutc": "2023-03-31T21:59:31.1123132+00:00" }, "equipment_family_id": "73ab45ad-87f0-4597-a9dd-ce29a72b3ffe", "equipment_family_code": "sample string 8", "equipment_family": { "id": "36570982-03db-4725-b19b-433aae63dd82", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "67183f43-0898-4976-8fbb-f611b28d3c46", "_parent_code": "sample string 6", "sales_organization_id": "205417bd-8836-4011-a3fc-e24868b20374", "sales_organization_code": "sample string 8", "sales_organization": { "id": "c348e2af-3599-49fa-a8a4-f6a7a15ef4ce", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "976bc64c-ce9b-49d4-8162-3988e4db655c", "db_currency_id": "3bc1908d-3338-49ed-9e35-f5479ffb33d4", "db_language_id": "762d7662-9617-4646-a34a-d2e57f834da9", "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-31T21:59:31.0966901+00:00" }, "modified_dateutc": "2023-03-31T21:59:31.1123132+00:00" }, "date_in_production_since": "2023-03-31T21:59:31.1123132+00:00", "date_out_of_production_since": "2023-03-31T21:59:31.1123132+00:00", "date_end_support": "2023-03-31T21:59:31.1123132+00:00", "sales_organization_id": "d659c49c-f9e4-4264-b6a6-a1fe21478e69", "sales_organization_code": "sample string 13", "sales_organization": { "id": "c348e2af-3599-49fa-a8a4-f6a7a15ef4ce", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "976bc64c-ce9b-49d4-8162-3988e4db655c", "db_currency_id": "3bc1908d-3338-49ed-9e35-f5479ffb33d4", "db_language_id": "762d7662-9617-4646-a34a-d2e57f834da9", "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-31T21:59:31.0966901+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-31T21:59:31.1123132+00:00" }, "project_status_id": "065e773a-88b3-4693-bb11-1fe2c72f0b54", "project_status_code": "sample string 10", "project_status": { "id": "5cef2987-eddb-4ff4-99ad-5be05b8de691", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "fe0c17c0-37b6-4623-8ca1-f8cdfc0c8711", "sales_organization_code": "sample string 6", "sales_organization": { "id": "c348e2af-3599-49fa-a8a4-f6a7a15ef4ce", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "976bc64c-ce9b-49d4-8162-3988e4db655c", "db_currency_id": "3bc1908d-3338-49ed-9e35-f5479ffb33d4", "db_language_id": "762d7662-9617-4646-a34a-d2e57f834da9", "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-31T21:59:31.0966901+00:00" }, "code": "sample string 7", "modified_dateutc": "2023-03-31T21:59:31.1123132+00:00" }, "company_id": "decad50a-8fbd-416d-a8ab-2554d3de4ffa", "company_code": "sample string 12", "db_address_id": "8e19530e-128f-49f8-9fed-72372dd2a953", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "ecd03dcb-8943-472f-8585-e652e914258b", "contact_reference_back_office": "sample string 17", "owner_user_id": "aed7166a-153b-4827-9cf6-74ce8c70f871", "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-31T21:59:31.1123132+00:00", "date_create": "2023-03-31T21:59:31.1123132+00:00", "date_update": "2023-03-31T21:59:31.1123132+00:00", "updated_by_user_id": "fdb843ee-1d04-4a47-93ef-0ffb399db6d3", "customer_reference": "sample string 28", "warranty_date_until": "2023-03-31T21:59:31.1123132+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-31T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2023-03-31T21:59:31.1123132+00:00", "date_last_job": "2023-03-31T21:59:31.1123132+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2023-03-31T21:59:31.1123132+00:00", "modified_dateutc": "2023-03-31T21:59:31.1123132+00:00", "is_mobile_installation": true }, "job_type_id": "bb76296a-6b1a-4b26-ae0c-df6f6341cef2", "job_type_code": "sample string 7", "job_type": { "id": "f2f425cf-b1bf-4715-9c9f-5a60356029cb", "name": "sample string 2", "sales_organization_id": "d39b4a86-a0f5-4cfa-86e0-c3409703729a", "description": "sample string 4", "is_default": true, "modified_dateutc": "2023-03-31T21:59:31.1123132+00:00", "code": "sample string 7" }, "job_priority_id": "39990d36-4ba4-423f-8ece-20da7d3e886c", "job_priority_code": "sample string 9", "job_priority": { "id": "cae479de-0607-4155-b34c-24ddc178f4c7", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "6a704f38-8f2e-47de-ae76-168d697a9b43", "sales_organization_code": "sample string 6", "sales_organization": { "id": "c348e2af-3599-49fa-a8a4-f6a7a15ef4ce", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "976bc64c-ce9b-49d4-8162-3988e4db655c", "db_currency_id": "3bc1908d-3338-49ed-9e35-f5479ffb33d4", "db_language_id": "762d7662-9617-4646-a34a-d2e57f834da9", "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-31T21:59:31.0966901+00:00" }, "code": "sample string 7", "modified_dateutc": "2023-03-31T21:59:31.1123132+00:00" }, "job_status_id": "56653248-5ea4-4426-82fb-90d1c3781eff", "job_status_code": "sample string 11", "db_address_id": "b87fcf29-4455-41de-98a1-5a7fb4c5c076", "contact_id": "2250ef99-ce28-4851-9673-0a13f1929fed", "requested_by_company_id": "36cddeb3-dbfe-4abb-9cd8-499c75c333ae", "requested_by_contact_id": "a48758d1-74bc-4bb2-9bf7-1bfe40ac3ba0", "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-31T21:59:31.1123132+00:00", "due_date": "2023-03-31T21:59:31.1123132+00:00", "date_create": "2023-03-31T21:59:31.1123132+00:00", "date_update": "2023-03-31T21:59:31.1123132+00:00", "date_closed": "2023-03-31T21:59:31.1123132+00:00", "suggested_user_id": "7c2c5c49-2cac-4bd2-82db-10472acf37bf", "suggested_user_code": "sample string 29", "suggested_user": { "id": "c7c1ef99-d7c1-48bb-bf44-37b40e0cb963", "db_language_id": "7018fe1c-425e-4ba9-8081-cbdb162d9856", "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-31T21:59:31.1123132+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "b0f2b793-3535-4a8a-bda6-e2b9b98d9727", "sales_organization": { "id": "c348e2af-3599-49fa-a8a4-f6a7a15ef4ce", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "976bc64c-ce9b-49d4-8162-3988e4db655c", "db_currency_id": "3bc1908d-3338-49ed-9e35-f5479ffb33d4", "db_language_id": "762d7662-9617-4646-a34a-d2e57f834da9", "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-31T21:59:31.0966901+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "a1f5c529-10f6-464a-8fb4-62bf891ed405", "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": "4f2f5ab1-d484-480d-9ba1-49ab475171d7", "private_db_country_code": "sample string 35", "modified_dateutc": "2023-03-31T21:59:31.1123132+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "aa7ec7de-f026-46a2-9e68-b71e4004b7a6" }, "suggested_date_start": "2023-03-31T21:59:31.1123132+00:00", "skill_id": "fb2cbaaa-dcbf-44e3-8938-85a58b70abdc", "skill_code": "sample string 32", "skill": { "id": "bd264ff7-e316-4cca-9e0a-3d10672533be", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "be6af6c1-7488-442d-8232-94217a3dde06", "sales_organization_code": "sample string 6", "sales_organization": { "id": "c348e2af-3599-49fa-a8a4-f6a7a15ef4ce", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "976bc64c-ce9b-49d4-8162-3988e4db655c", "db_currency_id": "3bc1908d-3338-49ed-9e35-f5479ffb33d4", "db_language_id": "762d7662-9617-4646-a34a-d2e57f834da9", "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-31T21:59:31.0966901+00:00" }, "modified_dateutc": "2023-03-31T21:59:31.1123132+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "7b19e78d-88a1-458a-aa74-f4bb2753c763", "date_reported_by_company": "2023-03-31T21:59:31.1123132+00:00", "id2": 36, "company_id": "5e2f8e38-ed8a-4bba-9d66-893ef67002e1", "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": "3e33dd9a-f9fe-4dff-9bc6-e35f7f0f7472", "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-31T21:59:31.1123132+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.