Updates the job work instruction list with the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters :
job_work_instruction_list| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier |
Required |
| jobs_id |
Foreign key of the jobs |
globally unique identifier |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs_reference_back_office |
Embedded entity "jobs" using ERP PK when adding/updating |
string |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs |
Embedded entity "jobs" when adding/updating |
jobs |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| work_instruction_details_id |
work instruction details id |
globally unique identifier | |
| work_instruction_details_reference_back_office |
Embedded code "work instruction details" when adding/updating |
string | |
| work_instruction_details |
Embedded entity "work instruction details" when adding/updating |
work_instruction_details | |
| user_id |
Filled by the person that completed that item on the checklist |
globally unique identifier | |
| work_instruction_action_type |
Value from work_instruction_action_type.name |
string | |
| work_instruction_id |
work instruction id |
globally unique identifier |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction_reference_back_office |
Embedded code "work instruction" when adding/updating |
string |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction |
Embedded entity "work instruction" when adding/updating |
work_instruction |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| name |
The "on what" |
string |
Required Max length: 4000 |
| status |
Status can be Ok,NotOk,Replaced,NotApplicable |
string |
Max length: 50 |
| date_done |
Datetime filled when status goes to one valable status. |
date | |
| remark |
Additional remark from the technician. |
string |
Max length: 255 |
| advise |
Additional advice from the technician. |
string |
Max length: 255 |
| sequence |
To order it. |
integer | |
| reference_back_office |
The Id/Ref of the back office for this job work instruction. Used by Embedded entity |
string |
Max length: 255 |
| group_name |
Name of the group |
string |
Max length: 4000 |
| group_sequence |
Order of the group |
integer | |
| type |
One of the possible types which are Regular, Form, Picture, UsedParts, BillableHours. Regular is the default |
string | |
| instruction_document_count |
Specify how many documents/photos must be added if type is Picture |
integer | |
| db_report_type_id |
When type is Form, you must specify which db_report_type must be filled |
globally unique identifier | |
| db_report_type_name |
When type is Form, you must specify which db_report_type must be filled |
string | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Request Formats :
application/json, text/json
Sample:
{
"id": "4a512369-1ba9-45ac-9cbd-faf733d51e46",
"jobs_id": "e504fefe-8134-41c6-a336-af4fb6577d1c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0deaa824-8839-491c-a0b1-fddcbab8bc2c",
"_parent_id": "7d93d2ef-ef79-4f21-95c5-84659f6f0d93",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4844a765-3c8b-4112-9ca2-0304ec3443e3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5e7d7e16-9810-43ab-a909-8945b0777541",
"_parent_id": "9037d204-0057-491c-9013-958734984595",
"root_parent_id": "691a3380-8218-4b5b-a3f4-500695fc651e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0946858f-a056-4500-b0ea-fc39a47585dc",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b0b44a5f-2522-4d12-bc28-4b6cd85e3a0e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "038fdfce-6c2b-4dd6-bc01-ba02b3f93e0c",
"_parent_code": "sample string 6",
"sales_organization_id": "ef44e0a1-409d-4538-8392-ff0141619512",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "eb795188-690f-4574-8ebc-b50b5e144170",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "df85acc1-9594-44e9-9a87-dcf9ab36cb79",
"db_currency_id": "54e4bd95-109a-4b85-ab23-f1b8e371313e",
"db_language_id": "2ba32c28-dec0-4a01-88b6-9e6071d9705b",
"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": "2026-02-09T11:25:35.6453098+00:00"
},
"modified_dateutc": "2026-02-09T11:25:35.6453098+00:00"
},
"equipment_model_id": "f01bd21b-b2bb-4a3d-adcc-d585818a3307",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "840a063a-7354-4a94-b25f-03b6fe2a0744",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7f4ed3d7-e10f-4fff-ad87-65a55b44eede",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9eed7e80-a719-4544-a5ce-d86925364bf9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2b7aa6d3-f851-44ea-8efd-05a726087455",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "eb795188-690f-4574-8ebc-b50b5e144170",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "df85acc1-9594-44e9-9a87-dcf9ab36cb79",
"db_currency_id": "54e4bd95-109a-4b85-ab23-f1b8e371313e",
"db_language_id": "2ba32c28-dec0-4a01-88b6-9e6071d9705b",
"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": "2026-02-09T11:25:35.6453098+00:00"
},
"modified_dateutc": "2026-02-09T11:25:35.6453098+00:00"
},
"equipment_family_id": "60f347f3-288f-4b80-9496-673adc0d48b0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b0b44a5f-2522-4d12-bc28-4b6cd85e3a0e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "038fdfce-6c2b-4dd6-bc01-ba02b3f93e0c",
"_parent_code": "sample string 6",
"sales_organization_id": "ef44e0a1-409d-4538-8392-ff0141619512",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "eb795188-690f-4574-8ebc-b50b5e144170",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "df85acc1-9594-44e9-9a87-dcf9ab36cb79",
"db_currency_id": "54e4bd95-109a-4b85-ab23-f1b8e371313e",
"db_language_id": "2ba32c28-dec0-4a01-88b6-9e6071d9705b",
"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": "2026-02-09T11:25:35.6453098+00:00"
},
"modified_dateutc": "2026-02-09T11:25:35.6453098+00:00"
},
"date_in_production_since": "2026-02-09T11:25:35.6453098+00:00",
"date_out_of_production_since": "2026-02-09T11:25:35.6453098+00:00",
"date_end_support": "2026-02-09T11:25:35.6453098+00:00",
"sales_organization_id": "00288807-630e-45bf-bf48-5fb490a7aa23",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "eb795188-690f-4574-8ebc-b50b5e144170",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "df85acc1-9594-44e9-9a87-dcf9ab36cb79",
"db_currency_id": "54e4bd95-109a-4b85-ab23-f1b8e371313e",
"db_language_id": "2ba32c28-dec0-4a01-88b6-9e6071d9705b",
"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": "2026-02-09T11:25:35.6453098+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": "2026-02-09T11:25:35.6453098+00:00"
},
"project_status_id": "213b50a7-8f3e-4ba8-bd0f-f9d3b0e929ab",
"project_status_code": "sample string 10",
"project_status": {
"id": "8c4d83c0-7298-43ca-9cf8-e963758f5449",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "99b77c4c-8093-4e63-81b0-4491e1d75b69",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eb795188-690f-4574-8ebc-b50b5e144170",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "df85acc1-9594-44e9-9a87-dcf9ab36cb79",
"db_currency_id": "54e4bd95-109a-4b85-ab23-f1b8e371313e",
"db_language_id": "2ba32c28-dec0-4a01-88b6-9e6071d9705b",
"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": "2026-02-09T11:25:35.6453098+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-09T11:25:35.6453098+00:00"
},
"company_id": "7b1b2acd-acc0-4191-8ca1-c739649e08cc",
"company_code": "sample string 12",
"db_address_id": "4f0447b9-89ce-412d-8707-ae835f0ec5a7",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "184f7e45-8ce0-47fa-911f-3791061e1b02",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "884d22fd-5fb2-43f6-8ea9-0373c51a59e4",
"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": "2026-02-09T11:25:35.6453098+00:00",
"date_create": "2026-02-09T11:25:35.6453098+00:00",
"date_update": "2026-02-09T11:25:35.6453098+00:00",
"updated_by_user_id": "feec518f-54d5-446c-b3e7-6dfdfe5e5cca",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-09T11:25:35.6453098+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": "2026-02-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-09T11:25:35.6453098+00:00",
"date_last_job": "2026-02-09T11:25:35.6453098+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-09T11:25:35.6453098+00:00",
"modified_dateutc": "2026-02-09T11:25:35.6453098+00:00",
"is_mobile_installation": true
},
"job_type_id": "375cb250-f816-4f01-b4d3-fe0bc25fa1fe",
"job_type_code": "sample string 7",
"job_type": {
"id": "33b8afd0-91ff-497e-9343-1f94b3ace06f",
"name": "sample string 2",
"sales_organization_id": "708ff839-81f3-4ce3-8397-5c6a24b73ba5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-09T11:25:35.6453098+00:00",
"code": "sample string 7"
},
"job_priority_id": "5e2a87bc-c405-429d-af64-a5bad5b4555c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "23bec6bf-770c-4484-ba81-09867b370426",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1b73521e-5af4-4472-8536-a6e90607f66b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eb795188-690f-4574-8ebc-b50b5e144170",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "df85acc1-9594-44e9-9a87-dcf9ab36cb79",
"db_currency_id": "54e4bd95-109a-4b85-ab23-f1b8e371313e",
"db_language_id": "2ba32c28-dec0-4a01-88b6-9e6071d9705b",
"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": "2026-02-09T11:25:35.6453098+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-09T11:25:35.6453098+00:00"
},
"job_status_id": "e7fbfe17-6c87-4538-ae4e-294345710aed",
"job_status_code": "sample string 11",
"db_address_id": "db13abcc-ebe6-46f4-bd19-e0da39f332bb",
"contact_id": "8e5dd5d0-4f58-4762-92fe-9a12a71589e0",
"requested_by_company_id": "9d8209d2-dcff-45f8-b3e8-6481c8c72ee3",
"requested_by_contact_id": "e880fe26-051a-449b-836b-724e7b021c82",
"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": "2026-02-09T11:25:35.6453098+00:00",
"due_date": "2026-02-09T11:25:35.6453098+00:00",
"date_create": "2026-02-09T11:25:35.6453098+00:00",
"date_update": "2026-02-09T11:25:35.6453098+00:00",
"date_closed": "2026-02-09T11:25:35.6453098+00:00",
"suggested_user_id": "24859c1f-611d-4329-9095-afbb4efdc6c6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d12cdd46-934d-44b9-8248-24e5a936ce4b",
"db_language_id": "06231f5d-48eb-4835-aca6-1f103cf16c05",
"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": "2026-02-09T11:25:35.6453098+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a5bbfaa5-a1bd-4fca-9ac5-5b4de77dbb9e",
"sales_organization": {
"id": "eb795188-690f-4574-8ebc-b50b5e144170",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "df85acc1-9594-44e9-9a87-dcf9ab36cb79",
"db_currency_id": "54e4bd95-109a-4b85-ab23-f1b8e371313e",
"db_language_id": "2ba32c28-dec0-4a01-88b6-9e6071d9705b",
"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": "2026-02-09T11:25:35.6453098+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "45cfd30f-1bed-47c6-824f-376ce00fed0b",
"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": "57532a6a-1a05-4f62-9353-d661e584e9d9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-09T11:25:35.6453098+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1d032520-c7b5-47b0-832d-970354d8c0df"
},
"suggested_date_start": "2026-02-09T11:25:35.6453098+00:00",
"skill_id": "4b346c03-ea84-4192-8e30-83a797866f52",
"skill_code": "sample string 32",
"skill": {
"id": "7b6c6d21-4b93-4708-9944-347c0d602b85",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8886e47f-2da8-47a4-85dc-d84c78609466",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eb795188-690f-4574-8ebc-b50b5e144170",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "df85acc1-9594-44e9-9a87-dcf9ab36cb79",
"db_currency_id": "54e4bd95-109a-4b85-ab23-f1b8e371313e",
"db_language_id": "2ba32c28-dec0-4a01-88b6-9e6071d9705b",
"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": "2026-02-09T11:25:35.6453098+00:00"
},
"modified_dateutc": "2026-02-09T11:25:35.6453098+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "961c73ed-05a3-406b-9d8b-990b44b80103",
"date_reported_by_company": "2026-02-09T11:25:35.6453098+00:00",
"id2": 36,
"company_id": "213917f6-d5da-4eaf-add3-2416f7a1030c",
"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": "63a48380-782b-4ddc-b115-6dc098a97037",
"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": "2026-02-09T11:25:35.6453098+00:00"
},
"work_instruction_details_id": "f6c15e5a-c079-4282-8ba3-ffd2f6692322",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d7575b46-b211-42ab-a772-11828108e264",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "36b98c81-eb48-480b-857c-86977ab745a9",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-09T11:25:35.6453098+00:00",
"remark": "sample string 13",
"advise": "sample string 14",
"sequence": 1,
"reference_back_office": "sample string 15",
"group_name": "sample string 16",
"group_sequence": 1,
"type": "sample string 17",
"instruction_document_count": 1,
"db_report_type_id": "8a257b6f-3ab2-4d7e-9f68-8632ad4b5771",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-09T11:25:35.6453098+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.