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": "05f684e9-025c-4387-87b5-38cf4d193360",
"jobs_id": "9b13c6f5-d959-4f3d-83d9-57ed0f0a643c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f16fe376-f7eb-4443-80b1-302a3531d59e",
"_parent_id": "ffa62795-1d90-4e26-bffc-6356c36f70e1",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "065dc8dc-def3-4a4f-9622-899606b3fea3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7c6bfe1c-4135-4bec-8ad3-b9789db7b32c",
"_parent_id": "6e824140-c263-45f1-9b47-b4f318d70c40",
"root_parent_id": "3a1a66b4-f2b7-4c76-ac53-9faf82356fc1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8b0fcf12-b274-4721-be42-c3b34d06ae3f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7501ecbb-1a08-4967-8069-31f8ba4a98b7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "64a50bc9-4ad4-4367-8a0f-9da9654e0905",
"_parent_code": "sample string 6",
"sales_organization_id": "335910f9-5d83-40bc-8d01-7d87688ba60f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5cbbe852-8d92-4575-8ce1-c191f4fb222b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "baa9fae6-9c09-4ad5-b14c-a5c1fc47f3c2",
"db_currency_id": "30fc3b09-4d04-4109-9670-325f2c2f8af9",
"db_language_id": "cc1180f3-b6b0-4a94-ab60-eb0cfce6cce7",
"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-07-06T09:59:34.3536647+00:00"
},
"modified_dateutc": "2026-07-06T09:59:34.3536647+00:00"
},
"equipment_model_id": "f9dbdf46-8030-4c9f-9b66-23b5684406a0",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3bc3adbc-d9ad-4226-8208-27e07099f7fb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9011a24f-3b31-4165-a88e-ec5f28e91120",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "24ce7f26-0646-4267-9321-453d52db32fd",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "980fea83-6a06-44d6-876e-1fb1c0811bb7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5cbbe852-8d92-4575-8ce1-c191f4fb222b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "baa9fae6-9c09-4ad5-b14c-a5c1fc47f3c2",
"db_currency_id": "30fc3b09-4d04-4109-9670-325f2c2f8af9",
"db_language_id": "cc1180f3-b6b0-4a94-ab60-eb0cfce6cce7",
"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-07-06T09:59:34.3536647+00:00"
},
"modified_dateutc": "2026-07-06T09:59:34.3536647+00:00"
},
"equipment_family_id": "5c5f271f-0042-4abc-a823-68f91d79117c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7501ecbb-1a08-4967-8069-31f8ba4a98b7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "64a50bc9-4ad4-4367-8a0f-9da9654e0905",
"_parent_code": "sample string 6",
"sales_organization_id": "335910f9-5d83-40bc-8d01-7d87688ba60f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5cbbe852-8d92-4575-8ce1-c191f4fb222b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "baa9fae6-9c09-4ad5-b14c-a5c1fc47f3c2",
"db_currency_id": "30fc3b09-4d04-4109-9670-325f2c2f8af9",
"db_language_id": "cc1180f3-b6b0-4a94-ab60-eb0cfce6cce7",
"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-07-06T09:59:34.3536647+00:00"
},
"modified_dateutc": "2026-07-06T09:59:34.3536647+00:00"
},
"date_in_production_since": "2026-07-06T09:59:34.3536647+00:00",
"date_out_of_production_since": "2026-07-06T09:59:34.3536647+00:00",
"date_end_support": "2026-07-06T09:59:34.3536647+00:00",
"sales_organization_id": "19b03795-318b-45a6-9245-b7b4b46df971",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5cbbe852-8d92-4575-8ce1-c191f4fb222b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "baa9fae6-9c09-4ad5-b14c-a5c1fc47f3c2",
"db_currency_id": "30fc3b09-4d04-4109-9670-325f2c2f8af9",
"db_language_id": "cc1180f3-b6b0-4a94-ab60-eb0cfce6cce7",
"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-07-06T09:59:34.3536647+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-07-06T09:59:34.3536647+00:00"
},
"project_status_id": "0753373c-eb35-44d1-abc5-a1b0c816ce3c",
"project_status_code": "sample string 10",
"project_status": {
"id": "f41bfe98-6293-4a0b-ac49-c8dc41700347",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ef436bf6-59ce-434f-8511-9d6b9467b3fb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5cbbe852-8d92-4575-8ce1-c191f4fb222b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "baa9fae6-9c09-4ad5-b14c-a5c1fc47f3c2",
"db_currency_id": "30fc3b09-4d04-4109-9670-325f2c2f8af9",
"db_language_id": "cc1180f3-b6b0-4a94-ab60-eb0cfce6cce7",
"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-07-06T09:59:34.3536647+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-06T09:59:34.3536647+00:00"
},
"company_id": "115d5926-682b-4615-998e-b61fa31ec3ed",
"company_code": "sample string 12",
"db_address_id": "3a69b7aa-7942-4b13-bd17-5983448607b0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "67bf349d-f235-4c97-a937-197cb8092667",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a0621e11-ad6c-4da0-9ee6-5fe6267e60ca",
"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-07-06T09:59:34.3536647+00:00",
"date_create": "2026-07-06T09:59:34.3536647+00:00",
"date_update": "2026-07-06T09:59:34.3536647+00:00",
"updated_by_user_id": "3bb6004f-0676-4de0-aee5-57f34d490546",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-06T09:59:34.3536647+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-07-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-06T09:59:34.3536647+00:00",
"date_last_job": "2026-07-06T09:59:34.3536647+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-06T09:59:34.3536647+00:00",
"modified_dateutc": "2026-07-06T09:59:34.3536647+00:00",
"is_mobile_installation": true
},
"job_type_id": "bf21e749-89ec-45ea-9735-8187d1da566a",
"job_type_code": "sample string 7",
"job_type": {
"id": "bee76965-562f-42c7-bfc9-0a2e108e08d6",
"name": "sample string 2",
"sales_organization_id": "4346a4bb-cbd0-46f9-8f23-915f1f10a4bd",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-06T09:59:34.3536647+00:00",
"code": "sample string 7"
},
"job_priority_id": "27c8c69c-fec6-4542-8430-90757659c7d5",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e01a92d2-2d46-46d0-a947-977097c73da5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "534f3eb6-e9c8-4cd0-b18a-c5c13b27e305",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5cbbe852-8d92-4575-8ce1-c191f4fb222b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "baa9fae6-9c09-4ad5-b14c-a5c1fc47f3c2",
"db_currency_id": "30fc3b09-4d04-4109-9670-325f2c2f8af9",
"db_language_id": "cc1180f3-b6b0-4a94-ab60-eb0cfce6cce7",
"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-07-06T09:59:34.3536647+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-06T09:59:34.3536647+00:00"
},
"job_status_id": "1c156dcd-1658-4434-b8c9-3165af8410dc",
"job_status_code": "sample string 11",
"db_address_id": "21d3a065-efc5-4d89-9c1f-bb0382a9f2e8",
"contact_id": "5b81a913-a512-497d-a73f-c981d786d636",
"requested_by_company_id": "45c8067e-f136-4802-a35d-80854bdc3702",
"requested_by_contact_id": "bab21e52-9289-4da8-8120-04c4f380f665",
"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-07-06T09:59:34.3536647+00:00",
"due_date": "2026-07-06T09:59:34.3536647+00:00",
"date_create": "2026-07-06T09:59:34.3536647+00:00",
"date_update": "2026-07-06T09:59:34.3536647+00:00",
"date_closed": "2026-07-06T09:59:34.3536647+00:00",
"suggested_user_id": "28e12666-b586-4dc8-9400-e17fd6fe1090",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0955be31-b7e4-42da-9157-927fa920ef00",
"db_language_id": "35c4c2d5-bde5-4594-9ed6-3f69b5bfa1e0",
"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-07-06T09:59:34.3536647+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d86daeda-fb77-4c4e-b9c2-ebcdb3240197",
"sales_organization": {
"id": "5cbbe852-8d92-4575-8ce1-c191f4fb222b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "baa9fae6-9c09-4ad5-b14c-a5c1fc47f3c2",
"db_currency_id": "30fc3b09-4d04-4109-9670-325f2c2f8af9",
"db_language_id": "cc1180f3-b6b0-4a94-ab60-eb0cfce6cce7",
"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-07-06T09:59:34.3536647+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d503f57f-b6ff-4d99-8f21-9d8ea528e997",
"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": "6e0843b4-14c3-40e0-92b1-83367f14ea6c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-06T09:59:34.3536647+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b8ff8ad6-2c97-4050-8ac2-00f8c9639ae4"
},
"suggested_date_start": "2026-07-06T09:59:34.3536647+00:00",
"skill_id": "9209b8a9-a83e-4f85-a5cd-bb77a55d54bb",
"skill_code": "sample string 32",
"skill": {
"id": "22f200fd-da8a-4497-922a-9d6ee7208f66",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d3d6bd48-41f6-4223-9239-beab6e2e4a1b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5cbbe852-8d92-4575-8ce1-c191f4fb222b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "baa9fae6-9c09-4ad5-b14c-a5c1fc47f3c2",
"db_currency_id": "30fc3b09-4d04-4109-9670-325f2c2f8af9",
"db_language_id": "cc1180f3-b6b0-4a94-ab60-eb0cfce6cce7",
"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-07-06T09:59:34.3536647+00:00"
},
"modified_dateutc": "2026-07-06T09:59:34.3536647+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "811f1434-2021-4fa8-a534-9ef9b40a39c5",
"date_reported_by_company": "2026-07-06T09:59:34.3536647+00:00",
"id2": 36,
"company_id": "3e832f72-c3c5-47d5-81f5-fc81aae2d892",
"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": "5503c6b5-1459-4a19-9559-fcbad20c4b15",
"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-07-06T09:59:34.3536647+00:00"
},
"work_instruction_details_id": "35aeb87d-e5bc-4f7d-833d-eb035fa790a1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c126c836-b551-489c-a214-47fd19b9c86d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f69c60d1-a9d5-41b7-b79c-77b89f13bdda",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-06T09:59:34.3536647+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": "93ba0549-8a21-414f-8292-cf42766a3d8f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-06T09:59:34.3536647+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.