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": "6750eb06-c463-4c52-ae9c-892d3bf1586d",
"jobs_id": "79dac3ab-425e-4054-8767-c92d8c31b3a8",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "551a1cdb-ed36-48fc-9923-183ef0007dde",
"_parent_id": "973ae708-daec-4b7b-acfa-609b018a54dc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2945a5f3-69b2-4c22-b8f9-7257e6bafbff",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5f800cd8-7dfb-4756-95bd-018b937afb1d",
"_parent_id": "5306cdec-6bfb-4477-b515-52ff5d16796c",
"root_parent_id": "42a54208-cf18-4d73-a0ef-dfd60ea611aa",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f20e3938-1d88-4ff6-b73e-fa2dd283fe5b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f0791966-05d6-4416-a2a1-bc9ac0217c8e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4b5eb248-e0b1-4c3e-a40d-e27af495b98f",
"_parent_code": "sample string 6",
"sales_organization_id": "31491371-84a1-4486-a2a3-09cf84a9d446",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "31f42780-7c93-44e8-9974-4a9fa19f01ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea8f46c8-a3f9-4b0c-8194-3b3b43b62683",
"db_currency_id": "2eaf5ea5-e75c-486a-94ce-b1a3fa2c18bc",
"db_language_id": "90c4c910-1e47-4fae-afff-3783e74ea510",
"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-07T11:11:36.3624472+00:00"
},
"modified_dateutc": "2026-10-07T11:11:36.3624472+00:00"
},
"equipment_model_id": "da64467d-9e01-4aca-be3f-741606bb0dfb",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d116cd9a-40fc-4463-93c0-484ecf4f38b8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a506a033-9440-4251-86ca-5d01b9057287",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4560ad43-fe86-46bb-8f4a-fd7c68502f32",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7c8a48c1-c664-40b0-bd30-cc41cc787a0c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "31f42780-7c93-44e8-9974-4a9fa19f01ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea8f46c8-a3f9-4b0c-8194-3b3b43b62683",
"db_currency_id": "2eaf5ea5-e75c-486a-94ce-b1a3fa2c18bc",
"db_language_id": "90c4c910-1e47-4fae-afff-3783e74ea510",
"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-07T11:11:36.3624472+00:00"
},
"modified_dateutc": "2026-10-07T11:11:36.3624472+00:00"
},
"equipment_family_id": "9ba13133-84b0-4537-a71b-e17032d76e00",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f0791966-05d6-4416-a2a1-bc9ac0217c8e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4b5eb248-e0b1-4c3e-a40d-e27af495b98f",
"_parent_code": "sample string 6",
"sales_organization_id": "31491371-84a1-4486-a2a3-09cf84a9d446",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "31f42780-7c93-44e8-9974-4a9fa19f01ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea8f46c8-a3f9-4b0c-8194-3b3b43b62683",
"db_currency_id": "2eaf5ea5-e75c-486a-94ce-b1a3fa2c18bc",
"db_language_id": "90c4c910-1e47-4fae-afff-3783e74ea510",
"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-07T11:11:36.3624472+00:00"
},
"modified_dateutc": "2026-10-07T11:11:36.3624472+00:00"
},
"date_in_production_since": "2026-10-07T11:11:36.3624472+00:00",
"date_out_of_production_since": "2026-10-07T11:11:36.3624472+00:00",
"date_end_support": "2026-10-07T11:11:36.3624472+00:00",
"sales_organization_id": "71ff8e8e-7066-4e20-8789-235a2ed87f7f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "31f42780-7c93-44e8-9974-4a9fa19f01ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea8f46c8-a3f9-4b0c-8194-3b3b43b62683",
"db_currency_id": "2eaf5ea5-e75c-486a-94ce-b1a3fa2c18bc",
"db_language_id": "90c4c910-1e47-4fae-afff-3783e74ea510",
"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-07T11:11:36.3624472+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-07T11:11:36.3780761+00:00"
},
"project_status_id": "f08bb833-9010-450d-9663-e6b7601efde1",
"project_status_code": "sample string 10",
"project_status": {
"id": "88ed51e1-4abd-43a4-b174-6db62ae62a45",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "886ba10f-ebee-49f4-a340-c1a6fec58883",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "31f42780-7c93-44e8-9974-4a9fa19f01ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea8f46c8-a3f9-4b0c-8194-3b3b43b62683",
"db_currency_id": "2eaf5ea5-e75c-486a-94ce-b1a3fa2c18bc",
"db_language_id": "90c4c910-1e47-4fae-afff-3783e74ea510",
"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-07T11:11:36.3624472+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-07T11:11:36.3780761+00:00"
},
"company_id": "94565430-882a-4600-afc2-d91feae263bf",
"company_code": "sample string 12",
"db_address_id": "0045ba64-a1af-440e-aad4-7ed1cf5be92f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "eb581d45-6001-4702-a4c2-8a456be45393",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ec32a797-e33a-4fba-987a-ded3c194e64d",
"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-07T11:11:36.3780761+00:00",
"date_create": "2026-10-07T11:11:36.3780761+00:00",
"date_update": "2026-10-07T11:11:36.3780761+00:00",
"updated_by_user_id": "26c50cb6-e5cc-4823-b7ae-95fca1570c34",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-07T11:11:36.3780761+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-07T11:11:36.3780761+00:00",
"date_last_job": "2026-10-07T11:11:36.3780761+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-07T11:11:36.3780761+00:00",
"modified_dateutc": "2026-10-07T11:11:36.3780761+00:00",
"is_mobile_installation": true
},
"job_type_id": "1e867a2e-1715-4d2c-9b08-c42edc1464c8",
"job_type_code": "sample string 7",
"job_type": {
"id": "a640d916-26da-4ef0-8b29-f6855c6c6412",
"name": "sample string 2",
"sales_organization_id": "d180d4b7-aad5-4515-84fe-79b811e7e184",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-07T11:11:36.3780761+00:00",
"code": "sample string 7"
},
"job_priority_id": "ae177f88-0061-4eec-9916-d6d2752f746c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d3bb9458-78e5-40f9-b8b0-52583e806a79",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7b00706c-46bd-48de-8a6a-5eee7c327201",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "31f42780-7c93-44e8-9974-4a9fa19f01ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea8f46c8-a3f9-4b0c-8194-3b3b43b62683",
"db_currency_id": "2eaf5ea5-e75c-486a-94ce-b1a3fa2c18bc",
"db_language_id": "90c4c910-1e47-4fae-afff-3783e74ea510",
"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-07T11:11:36.3624472+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-07T11:11:36.3780761+00:00"
},
"job_status_id": "819b2923-aad0-49a8-b7f6-fc91923d79bc",
"job_status_code": "sample string 11",
"db_address_id": "83b5e78f-9b72-4ed0-a1b1-dc9263c28f81",
"contact_id": "635af1d7-96a0-46de-9cf4-5394cca4da7a",
"requested_by_company_id": "9d8ad9be-c4f0-449c-8dc9-14a96903bedd",
"requested_by_contact_id": "410d0c57-a9aa-4dd8-bad4-dabe78cf612d",
"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-07T11:11:36.3780761+00:00",
"due_date": "2026-10-07T11:11:36.3780761+00:00",
"date_create": "2026-10-07T11:11:36.3780761+00:00",
"date_update": "2026-10-07T11:11:36.3780761+00:00",
"date_closed": "2026-10-07T11:11:36.3780761+00:00",
"suggested_user_id": "408df424-ef5f-4702-af5c-0f5dd904da19",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "09cb4284-2ddd-492c-9a33-ae5a5e21f0ed",
"db_language_id": "b2dda3e1-8ab2-4a8b-888b-d342dfc374fb",
"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-07T11:11:36.3780761+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ef9db9d0-cb82-4cee-b2d4-eb386ce5685b",
"sales_organization": {
"id": "31f42780-7c93-44e8-9974-4a9fa19f01ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea8f46c8-a3f9-4b0c-8194-3b3b43b62683",
"db_currency_id": "2eaf5ea5-e75c-486a-94ce-b1a3fa2c18bc",
"db_language_id": "90c4c910-1e47-4fae-afff-3783e74ea510",
"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-07T11:11:36.3624472+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4473948f-9b12-4565-9595-7556a7f0df0e",
"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": "cdf3f7da-a1ae-45f6-a832-03015f365675",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-07T11:11:36.3780761+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0d8fcfed-d72b-4b33-bf22-7484d979b28b"
},
"suggested_date_start": "2026-10-07T11:11:36.3780761+00:00",
"skill_id": "47bf574c-dea3-4778-bbc7-25907c79bc0f",
"skill_code": "sample string 32",
"skill": {
"id": "45698e2a-4dbe-43a2-a4ed-ab33b2b8ce92",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "02da46ae-c8cf-4c3a-bbb5-8bb7d80f4786",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "31f42780-7c93-44e8-9974-4a9fa19f01ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea8f46c8-a3f9-4b0c-8194-3b3b43b62683",
"db_currency_id": "2eaf5ea5-e75c-486a-94ce-b1a3fa2c18bc",
"db_language_id": "90c4c910-1e47-4fae-afff-3783e74ea510",
"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-07T11:11:36.3624472+00:00"
},
"modified_dateutc": "2026-10-07T11:11:36.3780761+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4b70f622-754c-4a6c-bd7a-0b32f1035416",
"date_reported_by_company": "2026-10-07T11:11:36.3780761+00:00",
"id2": 36,
"company_id": "1098c52f-5480-4faa-a23d-09aad3ee1ea1",
"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": "50f68629-8551-4616-8078-72e8a485e1a1",
"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-07T11:11:36.3780761+00:00"
},
"work_instruction_details_id": "a69b0489-099b-4841-a5dc-5dae452a15fe",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f07eb0be-a232-43cb-8372-a7d4366daa3b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2eb876a1-fc4f-4ba7-8335-f5ffef935efe",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-07T11:11:36.3780761+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": "01b310bf-e091-4b92-9019-a9bffeffa712",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-07T11:11:36.3780761+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.