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": "e0341a4c-6407-4df1-bc61-f7d902ae9deb",
"jobs_id": "95a417a7-9a8a-455c-a0a6-edc73693b087",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1e5f1628-e24d-41b8-ad7d-039931850ae3",
"_parent_id": "4e225cc4-5f34-47b0-9584-97718df7aeaf",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9eeb5002-60e7-4418-8d68-10907df555ff",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f0bc1fcb-86c4-4ddf-b530-824005795ac5",
"_parent_id": "9af90f2b-440a-4ca1-a382-5b0d8b268af3",
"root_parent_id": "671c83e7-4f12-4333-a59f-9ec7308f3b83",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "15081647-028f-47ae-ab62-0046502fb808",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ba6db6ad-9718-42d3-b8d9-77c82b95993f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "efbb0065-e69f-4eea-aabb-c0a3e42830df",
"_parent_code": "sample string 6",
"sales_organization_id": "ec81711f-875e-46ec-9f2d-ab3d052815b1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a940372b-1f64-45ae-be4a-029aef1b21cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "11fd0975-e42a-46ba-86ec-556407becfa7",
"db_currency_id": "71476ecb-e495-4600-8a54-46d01e130b1a",
"db_language_id": "85799421-7f0d-4f02-af08-da1bdbfea727",
"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-05-14T22:10:40.0250247+00:00"
},
"modified_dateutc": "2026-05-14T22:10:40.0250247+00:00"
},
"equipment_model_id": "2499ea47-4f32-4587-a5b2-f68cf8d31bba",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3e17c0e6-02f6-457e-b13c-63a9013e6886",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4d8e0f6c-f176-4e71-b4cd-17d3d4a33446",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1189df4a-7fb0-45ed-828a-611fb3452f63",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2664ce63-9dfc-4261-9598-3da33263ed13",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a940372b-1f64-45ae-be4a-029aef1b21cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "11fd0975-e42a-46ba-86ec-556407becfa7",
"db_currency_id": "71476ecb-e495-4600-8a54-46d01e130b1a",
"db_language_id": "85799421-7f0d-4f02-af08-da1bdbfea727",
"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-05-14T22:10:40.0250247+00:00"
},
"modified_dateutc": "2026-05-14T22:10:40.0250247+00:00"
},
"equipment_family_id": "245fcdef-be8a-4040-8cb8-cdff24ac9064",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ba6db6ad-9718-42d3-b8d9-77c82b95993f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "efbb0065-e69f-4eea-aabb-c0a3e42830df",
"_parent_code": "sample string 6",
"sales_organization_id": "ec81711f-875e-46ec-9f2d-ab3d052815b1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a940372b-1f64-45ae-be4a-029aef1b21cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "11fd0975-e42a-46ba-86ec-556407becfa7",
"db_currency_id": "71476ecb-e495-4600-8a54-46d01e130b1a",
"db_language_id": "85799421-7f0d-4f02-af08-da1bdbfea727",
"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-05-14T22:10:40.0250247+00:00"
},
"modified_dateutc": "2026-05-14T22:10:40.0250247+00:00"
},
"date_in_production_since": "2026-05-14T22:10:40.0250247+00:00",
"date_out_of_production_since": "2026-05-14T22:10:40.0250247+00:00",
"date_end_support": "2026-05-14T22:10:40.0250247+00:00",
"sales_organization_id": "c13b8c06-5f34-4e29-b6d6-f557fedd7e0f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a940372b-1f64-45ae-be4a-029aef1b21cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "11fd0975-e42a-46ba-86ec-556407becfa7",
"db_currency_id": "71476ecb-e495-4600-8a54-46d01e130b1a",
"db_language_id": "85799421-7f0d-4f02-af08-da1bdbfea727",
"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-05-14T22:10:40.0250247+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-05-14T22:10:40.0250247+00:00"
},
"project_status_id": "cebe8f29-9e6c-44b7-8219-72fed5d7894f",
"project_status_code": "sample string 10",
"project_status": {
"id": "398dc94a-463d-486f-af7b-3aa16a85f807",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "80da66aa-2e3a-428b-b65b-9e5dd019a1d0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a940372b-1f64-45ae-be4a-029aef1b21cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "11fd0975-e42a-46ba-86ec-556407becfa7",
"db_currency_id": "71476ecb-e495-4600-8a54-46d01e130b1a",
"db_language_id": "85799421-7f0d-4f02-af08-da1bdbfea727",
"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-05-14T22:10:40.0250247+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-14T22:10:40.0250247+00:00"
},
"company_id": "125f6134-7f2c-41db-9475-59874de942db",
"company_code": "sample string 12",
"db_address_id": "61e4be2f-316f-44fb-83c7-461cb2cecc76",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c8a32027-d5dc-471a-ba45-a68355ccd228",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7846b3ed-05cf-4f15-9532-d8d48615909a",
"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-05-14T22:10:40.0250247+00:00",
"date_create": "2026-05-14T22:10:40.0250247+00:00",
"date_update": "2026-05-14T22:10:40.0250247+00:00",
"updated_by_user_id": "4ac2c6d1-0474-4d46-ac98-d9f2eff1d477",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-14T22:10:40.0250247+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-05-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-14T22:10:40.0250247+00:00",
"date_last_job": "2026-05-14T22:10:40.0250247+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-14T22:10:40.0250247+00:00",
"modified_dateutc": "2026-05-14T22:10:40.0250247+00:00",
"is_mobile_installation": true
},
"job_type_id": "9204d819-083e-47e4-b559-7adee7fdfc3a",
"job_type_code": "sample string 7",
"job_type": {
"id": "528bc910-5c91-45e8-b0e4-f2bec7df79cf",
"name": "sample string 2",
"sales_organization_id": "a0180946-86b9-4d3e-a44e-b915a570baaa",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-14T22:10:40.0250247+00:00",
"code": "sample string 7"
},
"job_priority_id": "06e4123c-a8ae-4127-a5f4-6a2fdbd4d853",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e7ab5cb9-fabd-4291-bd19-a5440d83d4ec",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b60b4718-dfac-4b11-ac51-3d9e07d5173a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a940372b-1f64-45ae-be4a-029aef1b21cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "11fd0975-e42a-46ba-86ec-556407becfa7",
"db_currency_id": "71476ecb-e495-4600-8a54-46d01e130b1a",
"db_language_id": "85799421-7f0d-4f02-af08-da1bdbfea727",
"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-05-14T22:10:40.0250247+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-14T22:10:40.0250247+00:00"
},
"job_status_id": "01464faf-3f2d-4b4c-8127-df005db0fe16",
"job_status_code": "sample string 11",
"db_address_id": "0fd07246-3c6f-4f4c-9330-1d1e0d18b44d",
"contact_id": "fce4d65d-1c81-441d-9af9-bb5be86f2dca",
"requested_by_company_id": "71f749ce-7de1-42c6-b884-11031e08cb04",
"requested_by_contact_id": "0c2cbd81-949b-41e1-acab-d1496a6892c9",
"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-05-14T22:10:40.0250247+00:00",
"due_date": "2026-05-14T22:10:40.0250247+00:00",
"date_create": "2026-05-14T22:10:40.0250247+00:00",
"date_update": "2026-05-14T22:10:40.0250247+00:00",
"date_closed": "2026-05-14T22:10:40.0250247+00:00",
"suggested_user_id": "a8b3c963-7070-4c53-a278-01bcc7bc272e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "cf5301d9-9e60-43de-a71f-bb29cd606489",
"db_language_id": "04f8dde2-5111-4bbd-b0ba-7f3ab5b2b1c2",
"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-05-14T22:10:40.0250247+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "aee4089a-0afe-4052-9be2-bfb859bb68c6",
"sales_organization": {
"id": "a940372b-1f64-45ae-be4a-029aef1b21cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "11fd0975-e42a-46ba-86ec-556407becfa7",
"db_currency_id": "71476ecb-e495-4600-8a54-46d01e130b1a",
"db_language_id": "85799421-7f0d-4f02-af08-da1bdbfea727",
"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-05-14T22:10:40.0250247+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "fc0865c9-eefe-477a-92d8-99616b017fd7",
"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": "99f8dcba-0b93-4c62-9084-e543db49d027",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-14T22:10:40.0250247+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "52d39cdb-cfd3-442e-aeea-07543b32d231"
},
"suggested_date_start": "2026-05-14T22:10:40.0406472+00:00",
"skill_id": "f80274f5-b1f5-4f18-8f81-e9cf38452968",
"skill_code": "sample string 32",
"skill": {
"id": "b64001ba-7bc4-4afd-a219-4caae52bb7f8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7651fa8e-a852-439a-ae74-7de12fc3c68e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a940372b-1f64-45ae-be4a-029aef1b21cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "11fd0975-e42a-46ba-86ec-556407becfa7",
"db_currency_id": "71476ecb-e495-4600-8a54-46d01e130b1a",
"db_language_id": "85799421-7f0d-4f02-af08-da1bdbfea727",
"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-05-14T22:10:40.0250247+00:00"
},
"modified_dateutc": "2026-05-14T22:10:40.0406472+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "601300c8-c4fb-436c-883d-eaa763002e79",
"date_reported_by_company": "2026-05-14T22:10:40.0406472+00:00",
"id2": 36,
"company_id": "424b4fbf-1c80-4df8-970c-608b399b949c",
"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": "f6f2cee4-45cc-4e47-aeee-7557c59410dd",
"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-05-14T22:10:40.0406472+00:00"
},
"work_instruction_details_id": "1fedc577-3d14-493a-a652-16cc1b719ab6",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9ccdb4c0-8841-43b8-b643-355719ddeacb",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "aef8b4b9-7cea-49fb-b1ed-8deaee597dc1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-14T22:10:40.0406472+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": "0e96212f-011f-46b4-83e5-1777ddf80c61",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-14T22:10:40.0406472+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.