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": "faddd879-797d-497a-b197-fb1720c2fb16",
"jobs_id": "0e24e5ea-10d2-4fab-8ab6-282ca6ce2283",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "02a58638-d99a-4978-83cd-3b337b3815e7",
"_parent_id": "a5eb3b3c-e15d-4b60-b7c2-74bc7976ceae",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "eca6aee3-945d-4aec-adb2-908dfe065072",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f931f025-076c-42b5-8fa4-8d0ad68fa3fa",
"_parent_id": "f43a9791-9824-4c61-9a54-2c30053cdd15",
"root_parent_id": "4b359409-64f5-4baa-9074-040bf617c900",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "761f7cd6-5691-40d0-8c31-70fb8920affd",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b6808c99-004d-45bc-b7b3-3cacfbf8f15b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e060aec7-7904-4c01-b815-7b77be1a5afd",
"_parent_code": "sample string 6",
"sales_organization_id": "9ad0ad6b-5d1f-4a5e-996b-ab3f13e90091",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "caaa581f-fdb4-4c05-9b45-0f197fbcbfb3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "60c01305-954e-4946-b18c-06ad0ecf8684",
"db_currency_id": "36287386-10df-4c73-986a-05c4cec080f7",
"db_language_id": "6589ef7e-2ab4-4301-8147-ebbadd24ed73",
"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-10-19T16:41:02.8938665+00:00"
},
"modified_dateutc": "2026-10-19T16:41:02.8938665+00:00"
},
"equipment_model_id": "17e5f43e-8870-4cae-a337-7dea1441220d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "42f3879f-5e0c-45ab-b6cd-493374b3954b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "95d9599e-e77a-4a55-8787-75a0110e3ca0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d529fc5f-be91-49d4-b09b-3fa9f6fdc955",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "57a2db64-e06b-4ff3-87aa-7352731dfdf2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "caaa581f-fdb4-4c05-9b45-0f197fbcbfb3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "60c01305-954e-4946-b18c-06ad0ecf8684",
"db_currency_id": "36287386-10df-4c73-986a-05c4cec080f7",
"db_language_id": "6589ef7e-2ab4-4301-8147-ebbadd24ed73",
"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-10-19T16:41:02.8938665+00:00"
},
"modified_dateutc": "2026-10-19T16:41:02.8938665+00:00"
},
"equipment_family_id": "8416bc19-3051-4ac9-87b5-69f690ddd14a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b6808c99-004d-45bc-b7b3-3cacfbf8f15b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e060aec7-7904-4c01-b815-7b77be1a5afd",
"_parent_code": "sample string 6",
"sales_organization_id": "9ad0ad6b-5d1f-4a5e-996b-ab3f13e90091",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "caaa581f-fdb4-4c05-9b45-0f197fbcbfb3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "60c01305-954e-4946-b18c-06ad0ecf8684",
"db_currency_id": "36287386-10df-4c73-986a-05c4cec080f7",
"db_language_id": "6589ef7e-2ab4-4301-8147-ebbadd24ed73",
"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-10-19T16:41:02.8938665+00:00"
},
"modified_dateutc": "2026-10-19T16:41:02.8938665+00:00"
},
"date_in_production_since": "2026-10-19T16:41:02.8938665+00:00",
"date_out_of_production_since": "2026-10-19T16:41:02.8938665+00:00",
"date_end_support": "2026-10-19T16:41:02.8938665+00:00",
"sales_organization_id": "4276bc19-e937-4699-9b02-1f3771bef0a7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "caaa581f-fdb4-4c05-9b45-0f197fbcbfb3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "60c01305-954e-4946-b18c-06ad0ecf8684",
"db_currency_id": "36287386-10df-4c73-986a-05c4cec080f7",
"db_language_id": "6589ef7e-2ab4-4301-8147-ebbadd24ed73",
"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-10-19T16:41:02.8938665+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-10-19T16:41:02.8938665+00:00"
},
"project_status_id": "ad775fbf-0e67-46bd-8899-9c57d3e7775f",
"project_status_code": "sample string 10",
"project_status": {
"id": "14120455-6a52-4083-9178-eb1c0ab7e135",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d60287c3-9a70-48e1-82f7-c041bde418c0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "caaa581f-fdb4-4c05-9b45-0f197fbcbfb3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "60c01305-954e-4946-b18c-06ad0ecf8684",
"db_currency_id": "36287386-10df-4c73-986a-05c4cec080f7",
"db_language_id": "6589ef7e-2ab4-4301-8147-ebbadd24ed73",
"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-10-19T16:41:02.8938665+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-19T16:41:02.9139409+00:00"
},
"company_id": "c62e0da2-90f6-4487-8c1f-067e324a563b",
"company_code": "sample string 12",
"db_address_id": "a9514d5a-4fac-4fb3-8272-47d0f3df8b33",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "43718da8-db8b-41c2-a676-7a4e0af864bd",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "eca72d8a-28a4-4045-a1ee-fec8d1300beb",
"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-10-19T16:41:02.9139409+00:00",
"date_create": "2026-10-19T16:41:02.9139409+00:00",
"date_update": "2026-10-19T16:41:02.9139409+00:00",
"updated_by_user_id": "59df895e-2323-4d04-9ad7-3429bc61ebe4",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-19T16:41:02.9139409+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-10-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-19T16:41:02.9139409+00:00",
"date_last_job": "2026-10-19T16:41:02.9139409+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-19T16:41:02.9139409+00:00",
"modified_dateutc": "2026-10-19T16:41:02.9139409+00:00",
"is_mobile_installation": true
},
"job_type_id": "4d4a48ca-6161-48bb-9c47-c104f16f5238",
"job_type_code": "sample string 7",
"job_type": {
"id": "aed935fc-073c-44d6-a788-4cb1fc161898",
"name": "sample string 2",
"sales_organization_id": "034edb47-47dd-44d0-9768-be2e224f99b4",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-19T16:41:02.9139409+00:00",
"code": "sample string 7"
},
"job_priority_id": "a885add4-c8d6-4525-93b0-d35e9c7c3582",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5aa1848f-c750-409c-af4a-830adb9558cd",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "98f5c2ab-9134-442c-be8b-5e18221824dc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "caaa581f-fdb4-4c05-9b45-0f197fbcbfb3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "60c01305-954e-4946-b18c-06ad0ecf8684",
"db_currency_id": "36287386-10df-4c73-986a-05c4cec080f7",
"db_language_id": "6589ef7e-2ab4-4301-8147-ebbadd24ed73",
"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-10-19T16:41:02.8938665+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-19T16:41:02.9139409+00:00"
},
"job_status_id": "40c0b42d-6a6d-45ec-8946-f75b49132868",
"job_status_code": "sample string 11",
"db_address_id": "4ebc713b-85bd-4d0e-b645-40113eec7202",
"contact_id": "67151011-e597-49bc-b8ae-9f4574ef9032",
"requested_by_company_id": "2fa98381-a218-4263-946b-dd315a143e5b",
"requested_by_contact_id": "6afca8fb-9d71-4be8-b100-05eccb46aff3",
"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-10-19T16:41:02.9139409+00:00",
"due_date": "2026-10-19T16:41:02.9139409+00:00",
"date_create": "2026-10-19T16:41:02.9139409+00:00",
"date_update": "2026-10-19T16:41:02.9139409+00:00",
"date_closed": "2026-10-19T16:41:02.9139409+00:00",
"suggested_user_id": "b408f213-a01b-4466-8bb9-1845dbf5e739",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7258d94f-8eaf-44ad-bffb-2a9558b4c1a0",
"db_language_id": "59eb8192-3f94-4b39-8aff-160334d91903",
"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-10-19T16:41:02.9139409+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "15d25a71-ebd1-443e-8332-f3aa836aea62",
"sales_organization": {
"id": "caaa581f-fdb4-4c05-9b45-0f197fbcbfb3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "60c01305-954e-4946-b18c-06ad0ecf8684",
"db_currency_id": "36287386-10df-4c73-986a-05c4cec080f7",
"db_language_id": "6589ef7e-2ab4-4301-8147-ebbadd24ed73",
"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-10-19T16:41:02.8938665+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1102bf23-9e17-4be7-8dab-0d517cb789e8",
"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": "a70c27d0-097f-445d-bef3-9167edc61568",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-19T16:41:02.9139409+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "863cd848-184b-44b0-875f-2f72c02b0d01"
},
"suggested_date_start": "2026-10-19T16:41:02.9139409+00:00",
"skill_id": "4b7fc7ca-5f7d-453a-b61e-2e41916bed31",
"skill_code": "sample string 32",
"skill": {
"id": "a44a2d9e-5ea9-4b89-a451-1d266c112e03",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ea763c08-18ff-45d2-a4c1-84dc04024e15",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "caaa581f-fdb4-4c05-9b45-0f197fbcbfb3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "60c01305-954e-4946-b18c-06ad0ecf8684",
"db_currency_id": "36287386-10df-4c73-986a-05c4cec080f7",
"db_language_id": "6589ef7e-2ab4-4301-8147-ebbadd24ed73",
"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-10-19T16:41:02.8938665+00:00"
},
"modified_dateutc": "2026-10-19T16:41:02.9139409+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "738514c1-9627-4d8f-8c81-d1bab932f90f",
"date_reported_by_company": "2026-10-19T16:41:02.9139409+00:00",
"id2": 36,
"company_id": "7597a3ac-066c-4349-9135-f4ab7ffb499e",
"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": "ce8f6e51-f5f4-4b44-b0e1-88a37f390221",
"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-10-19T16:41:02.9243305+00:00"
},
"work_instruction_details_id": "4be0e588-d15f-46b2-999d-9e605033eac4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7474f793-623a-46b1-b438-2d4472993c12",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "620382aa-e999-482f-a307-46bf7e3d2fe8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-19T16:41:02.9243305+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": "629efaac-a662-4022-a374-4b463b821753",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-19T16:41:02.9243305+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.