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": "62b6dc4c-e255-4ca2-a0ac-ccee59eaa7b3",
"jobs_id": "d3835614-9432-4704-b3b2-b4e44863ce8c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4d75dc3a-6e4f-4590-b894-409c09f4b6d9",
"_parent_id": "df2e1d33-2246-4f43-a5c0-b142a7da6a1e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9ae17d85-73ec-4687-b3ca-175066b58387",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e008bb0f-f2bb-4d16-8aa7-2dbe6cf6768d",
"_parent_id": "7c855149-b439-47c2-8059-50118d0dbca6",
"root_parent_id": "7c8185a9-eefc-435a-b8b1-0faac8436f3e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "11e71459-3b86-452a-9544-3aa2212e0a4f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "26c6bcf0-2050-4307-a82a-3216435a9889",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "07bab601-8a74-414f-b2b8-1b7d8d585376",
"_parent_code": "sample string 6",
"sales_organization_id": "b627ef3a-b28f-4982-9fd2-e9c7d15d1e2e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6f48351c-7001-4622-903f-7461dfc4bbb9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f755440-ff49-4270-9d9f-39023e5e685d",
"db_currency_id": "ec29c052-991d-420c-938c-553bdc07d17c",
"db_language_id": "2c884d30-1fa1-48c9-a060-8ad05d11e127",
"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-07T08:11:44.7092307+00:00"
},
"modified_dateutc": "2026-10-07T08:11:44.7092307+00:00"
},
"equipment_model_id": "a92e3251-286a-417c-a3b1-efe72f2bd178",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a519db96-34ce-4882-88e8-afbbbbe9975e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "67274bca-f18d-42a4-8ab9-ed765dd3df1f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7b9c5110-2701-4cab-85a1-ef80f9e3e8df",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0b22b557-fc2d-4bd2-be23-6153c337cf6c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6f48351c-7001-4622-903f-7461dfc4bbb9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f755440-ff49-4270-9d9f-39023e5e685d",
"db_currency_id": "ec29c052-991d-420c-938c-553bdc07d17c",
"db_language_id": "2c884d30-1fa1-48c9-a060-8ad05d11e127",
"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-07T08:11:44.7092307+00:00"
},
"modified_dateutc": "2026-10-07T08:11:44.7092307+00:00"
},
"equipment_family_id": "2bdd93d7-d636-43ca-a484-a327528fcd8b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "26c6bcf0-2050-4307-a82a-3216435a9889",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "07bab601-8a74-414f-b2b8-1b7d8d585376",
"_parent_code": "sample string 6",
"sales_organization_id": "b627ef3a-b28f-4982-9fd2-e9c7d15d1e2e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6f48351c-7001-4622-903f-7461dfc4bbb9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f755440-ff49-4270-9d9f-39023e5e685d",
"db_currency_id": "ec29c052-991d-420c-938c-553bdc07d17c",
"db_language_id": "2c884d30-1fa1-48c9-a060-8ad05d11e127",
"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-07T08:11:44.7092307+00:00"
},
"modified_dateutc": "2026-10-07T08:11:44.7092307+00:00"
},
"date_in_production_since": "2026-10-07T08:11:44.7092307+00:00",
"date_out_of_production_since": "2026-10-07T08:11:44.7092307+00:00",
"date_end_support": "2026-10-07T08:11:44.7092307+00:00",
"sales_organization_id": "1236221a-e5ba-4692-8946-00557fb98bbf",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6f48351c-7001-4622-903f-7461dfc4bbb9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f755440-ff49-4270-9d9f-39023e5e685d",
"db_currency_id": "ec29c052-991d-420c-938c-553bdc07d17c",
"db_language_id": "2c884d30-1fa1-48c9-a060-8ad05d11e127",
"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-07T08:11:44.7092307+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-07T08:11:44.7092307+00:00"
},
"project_status_id": "6623d88d-f028-484f-b34e-d940838f9b9a",
"project_status_code": "sample string 10",
"project_status": {
"id": "10860ae4-af6c-4ccb-88c7-c39de3c7d3d4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1f7f1143-21ae-4f59-b7a4-ea1d28dadc1a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6f48351c-7001-4622-903f-7461dfc4bbb9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f755440-ff49-4270-9d9f-39023e5e685d",
"db_currency_id": "ec29c052-991d-420c-938c-553bdc07d17c",
"db_language_id": "2c884d30-1fa1-48c9-a060-8ad05d11e127",
"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-07T08:11:44.7092307+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-07T08:11:44.7308843+00:00"
},
"company_id": "3b9e2535-a619-444b-9d22-41a3779ae4ef",
"company_code": "sample string 12",
"db_address_id": "4944d184-7431-4a73-9d44-c91524a0039f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "86a634d3-1bbf-4eb4-8b58-d4fcfa1be8ba",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0599dea8-fe95-4e42-8ff6-ef8906a9fcf3",
"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-07T08:11:44.7308843+00:00",
"date_create": "2026-10-07T08:11:44.7308843+00:00",
"date_update": "2026-10-07T08:11:44.7308843+00:00",
"updated_by_user_id": "e46f0065-320c-46d0-8678-cf1a97adee55",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-07T08:11:44.7308843+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-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-07T08:11:44.7308843+00:00",
"date_last_job": "2026-10-07T08:11:44.7308843+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-07T08:11:44.7308843+00:00",
"modified_dateutc": "2026-10-07T08:11:44.7308843+00:00",
"is_mobile_installation": true
},
"job_type_id": "910bffa1-aaa9-44ef-8ab8-7a7a3ddb61cc",
"job_type_code": "sample string 7",
"job_type": {
"id": "b61103eb-0219-4230-ab2f-1f573e207034",
"name": "sample string 2",
"sales_organization_id": "dbfd9d03-a949-488f-a5b8-48fd0cb0a710",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-07T08:11:44.7308843+00:00",
"code": "sample string 7"
},
"job_priority_id": "d5ac0dfa-e21f-4afd-aeb1-1a35b3e9ab7e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "20639229-2822-48f2-a46e-140c18ed3735",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "76fdd558-dcf4-4848-91e7-0069ee203398",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6f48351c-7001-4622-903f-7461dfc4bbb9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f755440-ff49-4270-9d9f-39023e5e685d",
"db_currency_id": "ec29c052-991d-420c-938c-553bdc07d17c",
"db_language_id": "2c884d30-1fa1-48c9-a060-8ad05d11e127",
"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-07T08:11:44.7092307+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-07T08:11:44.7308843+00:00"
},
"job_status_id": "b2e7e4d7-8da3-4926-8687-5d15616c60ea",
"job_status_code": "sample string 11",
"db_address_id": "62924a04-df7e-4bd7-a164-2f5ea1435d9c",
"contact_id": "08a8046e-5456-4487-91df-80fd5e0fafa3",
"requested_by_company_id": "61cc8a43-dc7a-46e0-8143-5bc0525f7b9e",
"requested_by_contact_id": "55945f80-b0a9-414f-a10c-8a8b9729f3b9",
"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-07T08:11:44.7308843+00:00",
"due_date": "2026-10-07T08:11:44.7308843+00:00",
"date_create": "2026-10-07T08:11:44.7308843+00:00",
"date_update": "2026-10-07T08:11:44.7308843+00:00",
"date_closed": "2026-10-07T08:11:44.7308843+00:00",
"suggested_user_id": "3ebc07a0-6a37-45e9-91ec-4d0237bc73e8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a9e39331-8561-4280-b2c3-3b74ff7c41df",
"db_language_id": "8c35a5c8-97b4-42d2-b347-05922144dfd3",
"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-07T08:11:44.7308843+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "73c4ecae-078f-4fdb-9017-ce6f571fba15",
"sales_organization": {
"id": "6f48351c-7001-4622-903f-7461dfc4bbb9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f755440-ff49-4270-9d9f-39023e5e685d",
"db_currency_id": "ec29c052-991d-420c-938c-553bdc07d17c",
"db_language_id": "2c884d30-1fa1-48c9-a060-8ad05d11e127",
"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-07T08:11:44.7092307+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "42abce71-40df-4292-bdad-3cf295aec2c3",
"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": "c4d26bc4-7bac-41c1-8f38-31ae887d7fa1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-07T08:11:44.7399783+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9a90bb63-18f2-4eb4-9d43-0f06f485dc20"
},
"suggested_date_start": "2026-10-07T08:11:44.7399783+00:00",
"skill_id": "c1600b9f-82b0-4071-85be-eaac40a24bd8",
"skill_code": "sample string 32",
"skill": {
"id": "49d43972-464f-44de-ae45-5b21b1d0fb40",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "85321070-de99-47d6-86e6-c52f22d524eb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6f48351c-7001-4622-903f-7461dfc4bbb9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f755440-ff49-4270-9d9f-39023e5e685d",
"db_currency_id": "ec29c052-991d-420c-938c-553bdc07d17c",
"db_language_id": "2c884d30-1fa1-48c9-a060-8ad05d11e127",
"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-07T08:11:44.7092307+00:00"
},
"modified_dateutc": "2026-10-07T08:11:44.7399783+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "48408e27-7bb5-4497-9415-4526f66c7082",
"date_reported_by_company": "2026-10-07T08:11:44.7399783+00:00",
"id2": 36,
"company_id": "7eb3fb9c-ff1f-405d-bd82-d384e11a796b",
"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": "cc1d1ecf-2bfe-4f98-9f78-19378e22eb25",
"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-07T08:11:44.7399783+00:00"
},
"work_instruction_details_id": "44c2dc49-5a38-4b10-af62-fc0fa17471d5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "194a3dbe-a317-4573-a57c-c38920112709",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "80f4780d-ee8d-482f-a044-831aedafab97",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-07T08:11:44.7399783+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": "b5bd36c6-535e-498c-b46e-288f331deb16",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-07T08:11:44.7399783+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.