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": "f9105378-34e7-41fe-a5c7-f8d87efde027",
"jobs_id": "4e9e9b14-0ac0-4a03-90eb-e478777eedcc",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2d34ce23-534d-4844-b536-b30f0e8918f2",
"_parent_id": "20d89a3d-87d4-4e96-9d23-146cb9dba3d8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2ec29729-96a7-44e8-bb50-35fb44e89186",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e0e755ed-80f8-49b8-8e7e-d6a1368d68ef",
"_parent_id": "a1e2448f-c512-4d70-8260-fd1bff85438e",
"root_parent_id": "b55a3293-c63b-4253-8c9d-4a211ae90363",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2af5c384-7ad9-4212-be0c-d8d7cf4844ea",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "51e234f5-905c-42d1-924f-1d38161dd0bd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e5be0451-c125-4496-87c8-b72ad0713c6b",
"_parent_code": "sample string 6",
"sales_organization_id": "cbbdd5d5-af29-4680-be8c-2e62b0005ebc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a33534ee-45ee-405f-821d-c6384b84c77a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6964a71-7b35-43a9-b472-b18b1e370ccf",
"db_currency_id": "f68bbf3d-ae92-4388-97f7-9bdaf2016d82",
"db_language_id": "d48649a3-cb41-43bc-bb3d-34bd4d7e9166",
"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-01-22T20:49:09.2223493+00:00"
},
"modified_dateutc": "2026-01-22T20:49:09.2223493+00:00"
},
"equipment_model_id": "a5c55501-cd59-4da7-8cd2-b70291ce27f8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "efb154d4-088a-4692-80ee-a17b96278a30",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "535a5c9d-92a1-46de-8201-41902858ff58",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ebfecd95-549b-49f3-b4bb-4e06532d7804",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "df4033b5-bc4b-4426-8d33-619e4c33e5a9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a33534ee-45ee-405f-821d-c6384b84c77a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6964a71-7b35-43a9-b472-b18b1e370ccf",
"db_currency_id": "f68bbf3d-ae92-4388-97f7-9bdaf2016d82",
"db_language_id": "d48649a3-cb41-43bc-bb3d-34bd4d7e9166",
"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-01-22T20:49:09.2223493+00:00"
},
"modified_dateutc": "2026-01-22T20:49:09.2223493+00:00"
},
"equipment_family_id": "96ae0a2a-6762-45c0-b1c0-d2421f1e9636",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "51e234f5-905c-42d1-924f-1d38161dd0bd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e5be0451-c125-4496-87c8-b72ad0713c6b",
"_parent_code": "sample string 6",
"sales_organization_id": "cbbdd5d5-af29-4680-be8c-2e62b0005ebc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a33534ee-45ee-405f-821d-c6384b84c77a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6964a71-7b35-43a9-b472-b18b1e370ccf",
"db_currency_id": "f68bbf3d-ae92-4388-97f7-9bdaf2016d82",
"db_language_id": "d48649a3-cb41-43bc-bb3d-34bd4d7e9166",
"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-01-22T20:49:09.2223493+00:00"
},
"modified_dateutc": "2026-01-22T20:49:09.2223493+00:00"
},
"date_in_production_since": "2026-01-22T20:49:09.2223493+00:00",
"date_out_of_production_since": "2026-01-22T20:49:09.2223493+00:00",
"date_end_support": "2026-01-22T20:49:09.2223493+00:00",
"sales_organization_id": "8ca067b8-a65a-407f-a09a-d0566c8ed1a1",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a33534ee-45ee-405f-821d-c6384b84c77a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6964a71-7b35-43a9-b472-b18b1e370ccf",
"db_currency_id": "f68bbf3d-ae92-4388-97f7-9bdaf2016d82",
"db_language_id": "d48649a3-cb41-43bc-bb3d-34bd4d7e9166",
"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-01-22T20:49:09.2223493+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-01-22T20:49:09.2223493+00:00"
},
"project_status_id": "67e08996-a1de-4375-9d31-3a90bdd33fa8",
"project_status_code": "sample string 10",
"project_status": {
"id": "fcdcf2c4-c2ab-4eb7-bca6-687d2e7935e4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "458ff3f3-404f-41e3-9583-a0fc9579f787",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a33534ee-45ee-405f-821d-c6384b84c77a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6964a71-7b35-43a9-b472-b18b1e370ccf",
"db_currency_id": "f68bbf3d-ae92-4388-97f7-9bdaf2016d82",
"db_language_id": "d48649a3-cb41-43bc-bb3d-34bd4d7e9166",
"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-01-22T20:49:09.2223493+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-22T20:49:09.2223493+00:00"
},
"company_id": "88c1043f-48d8-4a8a-bc4e-fb3c2c4e3f49",
"company_code": "sample string 12",
"db_address_id": "52baab1c-4357-4712-a63b-b0a9c358cabe",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ea6bb924-6b7e-47c9-9a71-f5d2b56e7137",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c38350d2-7073-4516-9d6e-440366f1f364",
"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-01-22T20:49:09.2223493+00:00",
"date_create": "2026-01-22T20:49:09.2223493+00:00",
"date_update": "2026-01-22T20:49:09.2223493+00:00",
"updated_by_user_id": "977f7dab-4eb9-48d0-a928-5bb0f6124ea7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-22T20:49:09.2223493+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-01-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-22T20:49:09.2223493+00:00",
"date_last_job": "2026-01-22T20:49:09.2223493+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-22T20:49:09.2223493+00:00",
"modified_dateutc": "2026-01-22T20:49:09.2223493+00:00",
"is_mobile_installation": true
},
"job_type_id": "60b8faf8-13e5-45e3-bfcd-b0b53077cc83",
"job_type_code": "sample string 7",
"job_type": {
"id": "63652e34-52cb-4e32-b0f1-4a0d573970b0",
"name": "sample string 2",
"sales_organization_id": "6af3d188-9400-4fee-a929-2f470cc601ec",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-22T20:49:09.2223493+00:00",
"code": "sample string 7"
},
"job_priority_id": "53f7707c-8f1c-4b5b-8161-dd7479cc9441",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "88903e6a-86b8-46f3-8e66-aa0bb0efec37",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3c192088-fbc4-4983-a094-cf0cfa01bfab",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a33534ee-45ee-405f-821d-c6384b84c77a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6964a71-7b35-43a9-b472-b18b1e370ccf",
"db_currency_id": "f68bbf3d-ae92-4388-97f7-9bdaf2016d82",
"db_language_id": "d48649a3-cb41-43bc-bb3d-34bd4d7e9166",
"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-01-22T20:49:09.2223493+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-22T20:49:09.2223493+00:00"
},
"job_status_id": "24c015cd-bfaa-4a56-bb5e-1e8653b90240",
"job_status_code": "sample string 11",
"db_address_id": "9babce9a-e3f9-487e-b629-f6a2805c4e41",
"contact_id": "c6032574-73d9-4fac-b8e9-7d8a54487cc6",
"requested_by_company_id": "1382fe48-7536-4bb0-942e-fff1fbd971a3",
"requested_by_contact_id": "d69de3da-61b6-4d27-9d5f-08eb9e184ed6",
"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-01-22T20:49:09.2223493+00:00",
"due_date": "2026-01-22T20:49:09.2223493+00:00",
"date_create": "2026-01-22T20:49:09.2223493+00:00",
"date_update": "2026-01-22T20:49:09.2223493+00:00",
"date_closed": "2026-01-22T20:49:09.2223493+00:00",
"suggested_user_id": "32f448cb-38df-442c-b71b-59af85384893",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d13978bf-c32b-44bf-a16e-7db1d5c4325f",
"db_language_id": "0aa649f7-8d14-47fa-9246-30ef78976146",
"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-01-22T20:49:09.2223493+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d96b62fb-ce85-43ef-857d-cb0fe5815b9b",
"sales_organization": {
"id": "a33534ee-45ee-405f-821d-c6384b84c77a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6964a71-7b35-43a9-b472-b18b1e370ccf",
"db_currency_id": "f68bbf3d-ae92-4388-97f7-9bdaf2016d82",
"db_language_id": "d48649a3-cb41-43bc-bb3d-34bd4d7e9166",
"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-01-22T20:49:09.2223493+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1ea43ca3-e2ac-473a-bcaa-37491969f05b",
"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": "51f409d9-e755-4500-aa30-ef3ce0e095a8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-22T20:49:09.2223493+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f0e84a99-7eca-4dd1-99b0-218217e7662f"
},
"suggested_date_start": "2026-01-22T20:49:09.2223493+00:00",
"skill_id": "3966bd41-c642-4ccb-a7d6-89d2e0dea609",
"skill_code": "sample string 32",
"skill": {
"id": "463fd319-c3a9-45da-b397-69ce56535210",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "415ed4f6-4812-4465-901a-b3d06bde273a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a33534ee-45ee-405f-821d-c6384b84c77a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6964a71-7b35-43a9-b472-b18b1e370ccf",
"db_currency_id": "f68bbf3d-ae92-4388-97f7-9bdaf2016d82",
"db_language_id": "d48649a3-cb41-43bc-bb3d-34bd4d7e9166",
"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-01-22T20:49:09.2223493+00:00"
},
"modified_dateutc": "2026-01-22T20:49:09.2223493+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f3809b55-44d6-4c59-bb10-601a1eb30bfa",
"date_reported_by_company": "2026-01-22T20:49:09.2223493+00:00",
"id2": 36,
"company_id": "52e2906a-1d59-4a12-89ab-5af3ced4940e",
"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": "d888c4b2-5960-4440-840e-b2079c6b9453",
"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-01-22T20:49:09.2223493+00:00"
},
"work_instruction_details_id": "98e5e28d-ecae-4d71-acb4-636050ee5cf7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f8edd8a4-13b9-4f8b-94df-2fe9eec9bdaf",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e02d772d-4699-4e7a-bb90-642066943af6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-22T20:49:09.2223493+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": "ef26c628-056a-4fb9-9a26-b5f98ff29956",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-22T20:49:09.2379728+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.