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": "b7d89bf3-9a90-4316-ad03-5c7554fc5bf9",
"jobs_id": "3a69d8f2-fea6-4bfc-b6d1-befd6959f43a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4ac9975b-0fcc-4e8e-b5a5-e462a1278611",
"_parent_id": "f3870b9f-3337-4e94-979c-3d2591d57f9c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "cebdd012-2bdc-47aa-9cd1-7f4694fc80c6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7a3de1df-6907-46d4-be2a-aca12ff4e518",
"_parent_id": "1c46a201-8976-4e8f-86a4-3dbc2a3f57a8",
"root_parent_id": "7d86ffe3-35f8-4f5f-ad06-40e6f0bdb654",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4737698b-04ea-4deb-91df-4122c818e788",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "587ca0e9-1db4-44e8-b7f9-15192bac81e4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2b71163b-9c3c-4da8-bc71-591f55fa6446",
"_parent_code": "sample string 6",
"sales_organization_id": "d5c0af5b-b502-40cf-818d-7ac8347fa461",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3cd768d2-ca83-4af6-8fdc-cac31a47c7f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a11c4c0d-497e-454b-be34-1f455e098950",
"db_currency_id": "978cf1e5-a5eb-4f5c-8cab-f7257162562a",
"db_language_id": "af54c05a-61d7-4449-8999-01976bec1f75",
"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-09T03:24:36.8428434+00:00"
},
"modified_dateutc": "2026-02-09T03:24:36.8428434+00:00"
},
"equipment_model_id": "aef04e0f-c5ce-48db-b9f0-9767ec3a7838",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a4c400ae-01e6-417a-a564-0da4aa8907d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3c9b5dd7-a0e3-4fdd-af4d-2ac1a99531ad",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "dd4c7ed9-352a-4536-87e7-381b71baa60c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3149d806-b29c-458d-b8dd-25b5977fa5c5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3cd768d2-ca83-4af6-8fdc-cac31a47c7f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a11c4c0d-497e-454b-be34-1f455e098950",
"db_currency_id": "978cf1e5-a5eb-4f5c-8cab-f7257162562a",
"db_language_id": "af54c05a-61d7-4449-8999-01976bec1f75",
"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-09T03:24:36.8428434+00:00"
},
"modified_dateutc": "2026-02-09T03:24:36.8428434+00:00"
},
"equipment_family_id": "7cf8297d-83e1-400f-8648-68a23eea05d0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "587ca0e9-1db4-44e8-b7f9-15192bac81e4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2b71163b-9c3c-4da8-bc71-591f55fa6446",
"_parent_code": "sample string 6",
"sales_organization_id": "d5c0af5b-b502-40cf-818d-7ac8347fa461",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3cd768d2-ca83-4af6-8fdc-cac31a47c7f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a11c4c0d-497e-454b-be34-1f455e098950",
"db_currency_id": "978cf1e5-a5eb-4f5c-8cab-f7257162562a",
"db_language_id": "af54c05a-61d7-4449-8999-01976bec1f75",
"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-09T03:24:36.8428434+00:00"
},
"modified_dateutc": "2026-02-09T03:24:36.8428434+00:00"
},
"date_in_production_since": "2026-02-09T03:24:36.8428434+00:00",
"date_out_of_production_since": "2026-02-09T03:24:36.8428434+00:00",
"date_end_support": "2026-02-09T03:24:36.8428434+00:00",
"sales_organization_id": "65a06753-a80e-44eb-81e7-3a707c487165",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3cd768d2-ca83-4af6-8fdc-cac31a47c7f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a11c4c0d-497e-454b-be34-1f455e098950",
"db_currency_id": "978cf1e5-a5eb-4f5c-8cab-f7257162562a",
"db_language_id": "af54c05a-61d7-4449-8999-01976bec1f75",
"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-09T03:24:36.8428434+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-09T03:24:36.8428434+00:00"
},
"project_status_id": "022134dd-3871-4744-b9e2-f410d3d8554d",
"project_status_code": "sample string 10",
"project_status": {
"id": "ef62e0df-a4ed-47ec-9a5a-57400f0920f2",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "eb0e5388-f721-4d1e-9005-270ca24730ea",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3cd768d2-ca83-4af6-8fdc-cac31a47c7f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a11c4c0d-497e-454b-be34-1f455e098950",
"db_currency_id": "978cf1e5-a5eb-4f5c-8cab-f7257162562a",
"db_language_id": "af54c05a-61d7-4449-8999-01976bec1f75",
"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-09T03:24:36.8428434+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-09T03:24:36.8428434+00:00"
},
"company_id": "0337fc8f-3c90-4be7-9372-d7e1db7191fa",
"company_code": "sample string 12",
"db_address_id": "7f0738b2-1f86-46c3-9751-b5ce121fe743",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "fcb2163c-7747-467d-bc7d-eabcaf5f1dd7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0581bdfc-573c-4176-906b-90364ed08ff3",
"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-09T03:24:36.8428434+00:00",
"date_create": "2026-02-09T03:24:36.8428434+00:00",
"date_update": "2026-02-09T03:24:36.8428434+00:00",
"updated_by_user_id": "8f70da2f-62d5-41b0-ac2c-73f15b168b44",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-09T03:24:36.8428434+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-09T03:24:36.8428434+00:00",
"date_last_job": "2026-02-09T03:24:36.8428434+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-09T03:24:36.8428434+00:00",
"modified_dateutc": "2026-02-09T03:24:36.8428434+00:00",
"is_mobile_installation": true
},
"job_type_id": "2e6f7df7-73af-4e02-b576-1a34b0f26792",
"job_type_code": "sample string 7",
"job_type": {
"id": "58229346-bd19-482c-8527-c6dfbda56ea0",
"name": "sample string 2",
"sales_organization_id": "f3633630-8d15-4832-9841-f802be598ba8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-09T03:24:36.8428434+00:00",
"code": "sample string 7"
},
"job_priority_id": "6265a75f-f0a1-412c-ae8d-f87a551417d6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "83286c68-d0a7-4e0d-80f2-cde221c6e0f7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "aa47f5a1-04b2-4852-a23f-ec044ee90253",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3cd768d2-ca83-4af6-8fdc-cac31a47c7f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a11c4c0d-497e-454b-be34-1f455e098950",
"db_currency_id": "978cf1e5-a5eb-4f5c-8cab-f7257162562a",
"db_language_id": "af54c05a-61d7-4449-8999-01976bec1f75",
"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-09T03:24:36.8428434+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-09T03:24:36.8428434+00:00"
},
"job_status_id": "88dc9967-41ae-4a44-8b8e-cfb1a9eb2856",
"job_status_code": "sample string 11",
"db_address_id": "cfafb076-842a-4952-8dbf-8bcb3a68717f",
"contact_id": "1aefada6-1359-4ee9-a457-df0ecdd3dcbe",
"requested_by_company_id": "06bc98cd-1ca6-4140-a7f4-ccff949c4dc8",
"requested_by_contact_id": "190cafff-6e4a-406f-945c-f5ad4bf5a23d",
"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-09T03:24:36.8428434+00:00",
"due_date": "2026-02-09T03:24:36.8428434+00:00",
"date_create": "2026-02-09T03:24:36.8428434+00:00",
"date_update": "2026-02-09T03:24:36.8428434+00:00",
"date_closed": "2026-02-09T03:24:36.8428434+00:00",
"suggested_user_id": "dddb1cd5-ff38-48be-b225-93f4c3adc820",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e695d6c1-2b89-4205-a8c4-9b8dd3fb4e5e",
"db_language_id": "1a0bfd6d-960f-49dd-bf7b-6c0acbc0cfb6",
"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-09T03:24:36.8428434+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4c31f3f7-32ef-4e0b-b7e0-984a16eed2a5",
"sales_organization": {
"id": "3cd768d2-ca83-4af6-8fdc-cac31a47c7f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a11c4c0d-497e-454b-be34-1f455e098950",
"db_currency_id": "978cf1e5-a5eb-4f5c-8cab-f7257162562a",
"db_language_id": "af54c05a-61d7-4449-8999-01976bec1f75",
"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-09T03:24:36.8428434+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6e56f42c-535f-4674-8f5b-4594534015c8",
"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": "5a9625eb-cabe-4d04-a42e-6c8e8d925712",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-09T03:24:36.8428434+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ac765900-5fb6-46cd-b79a-1e1caa92a9ba"
},
"suggested_date_start": "2026-02-09T03:24:36.8428434+00:00",
"skill_id": "ee02af92-ce8c-4794-bd15-ac51dd3649eb",
"skill_code": "sample string 32",
"skill": {
"id": "07ac82a7-0c35-4e99-ab1c-9111bf53a71e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ff6a68b8-39f4-42ed-9e6a-a2f89796b4ef",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3cd768d2-ca83-4af6-8fdc-cac31a47c7f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a11c4c0d-497e-454b-be34-1f455e098950",
"db_currency_id": "978cf1e5-a5eb-4f5c-8cab-f7257162562a",
"db_language_id": "af54c05a-61d7-4449-8999-01976bec1f75",
"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-09T03:24:36.8428434+00:00"
},
"modified_dateutc": "2026-02-09T03:24:36.8428434+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "cd4cf8f3-41f1-4c4f-8282-cd44afcb99de",
"date_reported_by_company": "2026-02-09T03:24:36.8428434+00:00",
"id2": 36,
"company_id": "add74d2a-e803-4df8-847e-745c0191c1b0",
"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": "3c33aedd-fe3b-4835-9317-66411beecbde",
"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-09T03:24:36.8428434+00:00"
},
"work_instruction_details_id": "0750dcfa-9ce1-4ecb-95b9-2bfdda32774a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7ca79aa5-dd56-4ba3-86c7-3ab0be6de675",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "14f1c334-39c6-4a0b-b355-48e7a902d499",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-09T03:24:36.8428434+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": "1128bed7-5bae-4a27-9fa0-8abebe5d39ae",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-09T03:24:36.8428434+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.