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": "f020a754-8dd9-4b57-ab26-5c8ae5b08fb4",
"jobs_id": "51f4cc9c-2261-4d09-bfee-d886e46ff557",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b823d58d-0766-4ae2-891d-42c88ce915ef",
"_parent_id": "2e817eb2-345b-4aca-9fc0-a7664658b931",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "34a23b54-2906-4e64-b844-8fd245d0c816",
"project_reference_back_office": "sample string 5",
"project": {
"id": "34fc016c-d565-4b90-8c06-dca4528af61a",
"_parent_id": "c4d68de0-4276-45f0-85cf-99d89b44b737",
"root_parent_id": "af39066c-e147-406f-b8a5-98b3fd9433f4",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "01668218-3f10-4edf-a780-ee39f4491f1b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1bae3bfe-11ec-4d9a-b5eb-16a2d8936b8f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2e2b87ec-794f-489e-b504-b567fbd495fb",
"_parent_code": "sample string 6",
"sales_organization_id": "ab649451-1670-47c3-8790-0a32b901ad07",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4b945f2c-7924-43ba-a9c5-20b6821c637d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a32e33f9-3281-4975-a185-f7d50540b4f2",
"db_currency_id": "98ec5f35-0da4-49da-845c-73ba93e28e3c",
"db_language_id": "a7818889-bbc9-4abd-9b37-de5027ece424",
"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-08-09T05:16:44.1248012+00:00"
},
"modified_dateutc": "2026-08-09T05:16:44.1248012+00:00"
},
"equipment_model_id": "72b80a4d-85b6-4eae-8091-956b87d63e18",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5667c963-7a4f-484e-8fad-3fff08fe4a71",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "27c099d6-6dff-4334-9290-fce8f6aa2115",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "fe1019c9-8102-4131-8ebc-12d2a789b3c4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4bcba2db-9d3c-4349-a5ab-7891ec97a968",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4b945f2c-7924-43ba-a9c5-20b6821c637d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a32e33f9-3281-4975-a185-f7d50540b4f2",
"db_currency_id": "98ec5f35-0da4-49da-845c-73ba93e28e3c",
"db_language_id": "a7818889-bbc9-4abd-9b37-de5027ece424",
"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-08-09T05:16:44.1248012+00:00"
},
"modified_dateutc": "2026-08-09T05:16:44.1248012+00:00"
},
"equipment_family_id": "69ddcbd0-3fac-4faf-8b2a-f93adb1348d0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1bae3bfe-11ec-4d9a-b5eb-16a2d8936b8f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2e2b87ec-794f-489e-b504-b567fbd495fb",
"_parent_code": "sample string 6",
"sales_organization_id": "ab649451-1670-47c3-8790-0a32b901ad07",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4b945f2c-7924-43ba-a9c5-20b6821c637d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a32e33f9-3281-4975-a185-f7d50540b4f2",
"db_currency_id": "98ec5f35-0da4-49da-845c-73ba93e28e3c",
"db_language_id": "a7818889-bbc9-4abd-9b37-de5027ece424",
"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-08-09T05:16:44.1248012+00:00"
},
"modified_dateutc": "2026-08-09T05:16:44.1248012+00:00"
},
"date_in_production_since": "2026-08-09T05:16:44.1248012+00:00",
"date_out_of_production_since": "2026-08-09T05:16:44.1248012+00:00",
"date_end_support": "2026-08-09T05:16:44.1248012+00:00",
"sales_organization_id": "bad7f80d-ebe7-4e24-84f6-bbe0a85f76fe",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4b945f2c-7924-43ba-a9c5-20b6821c637d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a32e33f9-3281-4975-a185-f7d50540b4f2",
"db_currency_id": "98ec5f35-0da4-49da-845c-73ba93e28e3c",
"db_language_id": "a7818889-bbc9-4abd-9b37-de5027ece424",
"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-08-09T05:16:44.1248012+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-08-09T05:16:44.1248012+00:00"
},
"project_status_id": "e6eefa9d-d27f-4751-9d2a-abbab9a3f8b7",
"project_status_code": "sample string 10",
"project_status": {
"id": "cd666dd0-2cbc-412b-84cf-418f990b3f6f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f547598e-944e-4a9d-bb26-95cb8a71112f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4b945f2c-7924-43ba-a9c5-20b6821c637d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a32e33f9-3281-4975-a185-f7d50540b4f2",
"db_currency_id": "98ec5f35-0da4-49da-845c-73ba93e28e3c",
"db_language_id": "a7818889-bbc9-4abd-9b37-de5027ece424",
"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-08-09T05:16:44.1248012+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-09T05:16:44.1248012+00:00"
},
"company_id": "36fba8ca-a811-4701-9ce5-39597e56e568",
"company_code": "sample string 12",
"db_address_id": "c39f953e-c9d8-4da5-85db-54b4266cea75",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cec1359f-c38c-4f7f-acbf-bbf324721983",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e26acc40-40a5-41a6-b048-1983d545065b",
"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-08-09T05:16:44.1248012+00:00",
"date_create": "2026-08-09T05:16:44.1248012+00:00",
"date_update": "2026-08-09T05:16:44.1248012+00:00",
"updated_by_user_id": "ab742e52-9d84-42ec-9c0d-4ea132188ddb",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-09T05:16:44.1248012+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-08-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-09T05:16:44.1248012+00:00",
"date_last_job": "2026-08-09T05:16:44.1248012+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-09T05:16:44.1248012+00:00",
"modified_dateutc": "2026-08-09T05:16:44.1248012+00:00",
"is_mobile_installation": true
},
"job_type_id": "90605c19-a2e9-4041-a85d-cd571616a128",
"job_type_code": "sample string 7",
"job_type": {
"id": "3d052b4a-624d-4aa7-9cbc-979b931c37e3",
"name": "sample string 2",
"sales_organization_id": "e8951842-9a98-4fc9-81a3-c6e77ad1fae9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-09T05:16:44.1248012+00:00",
"code": "sample string 7"
},
"job_priority_id": "4b937438-a599-4678-b7e0-2665eded4c7f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0be23a0a-efaf-4cdb-8497-e3bf16c03635",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "441ee26b-54d5-4cad-bcbc-ecf1bf181037",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4b945f2c-7924-43ba-a9c5-20b6821c637d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a32e33f9-3281-4975-a185-f7d50540b4f2",
"db_currency_id": "98ec5f35-0da4-49da-845c-73ba93e28e3c",
"db_language_id": "a7818889-bbc9-4abd-9b37-de5027ece424",
"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-08-09T05:16:44.1248012+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-09T05:16:44.1248012+00:00"
},
"job_status_id": "e4b17101-adcf-411b-8b99-9d93b61b0cd8",
"job_status_code": "sample string 11",
"db_address_id": "ccafab34-d939-4dd6-a958-0ceaadbff4d2",
"contact_id": "c35b859d-6aec-4b26-8c7a-50a98e6f4bc6",
"requested_by_company_id": "2374e581-c078-450a-8b91-53e42e991dee",
"requested_by_contact_id": "65b0fe9b-36ae-48c9-8536-fad028364e29",
"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-08-09T05:16:44.1248012+00:00",
"due_date": "2026-08-09T05:16:44.1248012+00:00",
"date_create": "2026-08-09T05:16:44.1248012+00:00",
"date_update": "2026-08-09T05:16:44.1248012+00:00",
"date_closed": "2026-08-09T05:16:44.1248012+00:00",
"suggested_user_id": "107f0191-922b-4002-8e54-5d7b597a23b5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "70e7616c-0c3a-47de-a348-5741a049bd46",
"db_language_id": "a8f02204-290a-422f-9a63-c21fb3f5b787",
"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-08-09T05:16:44.1248012+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ceeca448-e9a8-434b-b633-0ce2b28cd73f",
"sales_organization": {
"id": "4b945f2c-7924-43ba-a9c5-20b6821c637d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a32e33f9-3281-4975-a185-f7d50540b4f2",
"db_currency_id": "98ec5f35-0da4-49da-845c-73ba93e28e3c",
"db_language_id": "a7818889-bbc9-4abd-9b37-de5027ece424",
"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-08-09T05:16:44.1248012+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "424425bd-29b8-4de4-914b-73a27095a337",
"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": "ea9a435a-1e54-491c-b908-605eef60667a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-09T05:16:44.1248012+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "86beff92-e267-4fa8-8284-13d39bdfffe7"
},
"suggested_date_start": "2026-08-09T05:16:44.1248012+00:00",
"skill_id": "6f7f7299-cf0c-4915-b504-f89f46c63e8c",
"skill_code": "sample string 32",
"skill": {
"id": "13dd2e4a-c23b-4331-8d42-c02d925ee97e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c8aa5119-0b72-49fc-be16-3ac766df0697",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4b945f2c-7924-43ba-a9c5-20b6821c637d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a32e33f9-3281-4975-a185-f7d50540b4f2",
"db_currency_id": "98ec5f35-0da4-49da-845c-73ba93e28e3c",
"db_language_id": "a7818889-bbc9-4abd-9b37-de5027ece424",
"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-08-09T05:16:44.1248012+00:00"
},
"modified_dateutc": "2026-08-09T05:16:44.1248012+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "adf8a055-bbd7-4f77-80f8-c7ad79281260",
"date_reported_by_company": "2026-08-09T05:16:44.1248012+00:00",
"id2": 36,
"company_id": "a2a5fae7-a67e-4c18-bb12-61bb5d3c36b7",
"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": "b83b920d-dff3-43e9-8cd3-37fefb0bedaf",
"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-08-09T05:16:44.1248012+00:00"
},
"work_instruction_details_id": "8028ea3d-7f99-483d-86b6-d47ad3241740",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "43a11689-4975-456f-9cf3-34976ab68072",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c452bac7-ea05-4402-8cbb-6a514ada4f40",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-09T05:16:44.1248012+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": "665acfda-d759-4a7d-a3d2-9a9cdc38806f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-09T05:16:44.1248012+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.