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": "10f82490-a07f-4463-91f4-932371f86050",
"jobs_id": "33f8c198-9975-4969-91ee-76c24b8a3aed",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "72f38b29-c480-41ce-9251-a359be05bb01",
"_parent_id": "5f243fd0-184f-4c90-8d8e-09ffe6e6841b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "499ed481-2640-41dd-b5c9-b120ef3422e5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "636ff3f2-ce11-418a-921e-e198831f3746",
"_parent_id": "145cb8bf-3878-4c1a-925b-b2f5e460c302",
"root_parent_id": "7218545a-5e0b-4c67-82e6-40def6620a32",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3bf72274-441b-4d03-b9fe-0314695e7e52",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "cda6d675-be48-4824-9df1-4678fcc180d9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "59f68e32-827f-457f-868a-8535d0c399e6",
"_parent_code": "sample string 6",
"sales_organization_id": "dd9787b6-fa7d-4e0d-a191-eb4427046be9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cd00b815-f78e-484c-9931-1afa290524f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a947b571-da32-4440-89c4-6110ab6c6343",
"db_currency_id": "a35220b1-77b0-4e27-9845-5b2071aaf138",
"db_language_id": "cea27208-73e3-4f96-8819-7824222a540d",
"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": "2025-11-17T02:34:32.8350827+00:00"
},
"modified_dateutc": "2025-11-17T02:34:32.8350827+00:00"
},
"equipment_model_id": "cc468bef-ba7a-4b91-8124-ee3eab06e99e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "964dc26e-dd96-45e4-9256-9de06bd18b7c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1f34124a-8e63-4488-b736-aaea1e2d8e2a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "30dcd4fb-d03c-4e58-a138-242319c0a648",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "24a2f73c-5406-42fa-9bdc-328ef792a783",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cd00b815-f78e-484c-9931-1afa290524f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a947b571-da32-4440-89c4-6110ab6c6343",
"db_currency_id": "a35220b1-77b0-4e27-9845-5b2071aaf138",
"db_language_id": "cea27208-73e3-4f96-8819-7824222a540d",
"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": "2025-11-17T02:34:32.8350827+00:00"
},
"modified_dateutc": "2025-11-17T02:34:32.8350827+00:00"
},
"equipment_family_id": "f8d337c2-3298-474d-944d-830b3da6e236",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "cda6d675-be48-4824-9df1-4678fcc180d9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "59f68e32-827f-457f-868a-8535d0c399e6",
"_parent_code": "sample string 6",
"sales_organization_id": "dd9787b6-fa7d-4e0d-a191-eb4427046be9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cd00b815-f78e-484c-9931-1afa290524f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a947b571-da32-4440-89c4-6110ab6c6343",
"db_currency_id": "a35220b1-77b0-4e27-9845-5b2071aaf138",
"db_language_id": "cea27208-73e3-4f96-8819-7824222a540d",
"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": "2025-11-17T02:34:32.8350827+00:00"
},
"modified_dateutc": "2025-11-17T02:34:32.8350827+00:00"
},
"date_in_production_since": "2025-11-17T02:34:32.8350827+00:00",
"date_out_of_production_since": "2025-11-17T02:34:32.8350827+00:00",
"date_end_support": "2025-11-17T02:34:32.8350827+00:00",
"sales_organization_id": "8a86219e-6637-4557-89d2-63701677ac4a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "cd00b815-f78e-484c-9931-1afa290524f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a947b571-da32-4440-89c4-6110ab6c6343",
"db_currency_id": "a35220b1-77b0-4e27-9845-5b2071aaf138",
"db_language_id": "cea27208-73e3-4f96-8819-7824222a540d",
"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": "2025-11-17T02:34:32.8350827+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": "2025-11-17T02:34:32.8507053+00:00"
},
"project_status_id": "ceb1d090-3623-4d2f-bc6e-33be022ed45f",
"project_status_code": "sample string 10",
"project_status": {
"id": "12ea5de9-7aa1-4b52-9d82-9a38e890d6a6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fcc64ff3-a7d3-4ecb-a64f-0c52585a4b0e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cd00b815-f78e-484c-9931-1afa290524f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a947b571-da32-4440-89c4-6110ab6c6343",
"db_currency_id": "a35220b1-77b0-4e27-9845-5b2071aaf138",
"db_language_id": "cea27208-73e3-4f96-8819-7824222a540d",
"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": "2025-11-17T02:34:32.8350827+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-17T02:34:32.8507053+00:00"
},
"company_id": "433d0e76-d53e-4dbc-88a0-797997d5cfb2",
"company_code": "sample string 12",
"db_address_id": "7f270942-e723-4782-b029-818dbba8eb0e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b6995336-c675-43e5-ab4e-64cf82a51be3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2693cf54-ef9c-4f4e-a4be-10ba9311dab6",
"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": "2025-11-17T02:34:32.8507053+00:00",
"date_create": "2025-11-17T02:34:32.8507053+00:00",
"date_update": "2025-11-17T02:34:32.8507053+00:00",
"updated_by_user_id": "0a85d9f8-f332-4742-a5c4-0515e366cc9d",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-17T02:34:32.8507053+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": "2025-11-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-17T02:34:32.8507053+00:00",
"date_last_job": "2025-11-17T02:34:32.8507053+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-17T02:34:32.8507053+00:00",
"modified_dateutc": "2025-11-17T02:34:32.8507053+00:00",
"is_mobile_installation": true
},
"job_type_id": "d2a79dfb-c553-4f72-9357-01a3b7b3601f",
"job_type_code": "sample string 7",
"job_type": {
"id": "324dac8d-bad8-4039-846c-759d237ca433",
"name": "sample string 2",
"sales_organization_id": "39dcb7d0-c84b-4fd8-9163-01ae2273aa26",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-17T02:34:32.8507053+00:00",
"code": "sample string 7"
},
"job_priority_id": "ba4ea959-038a-48de-980e-cdb631b25dfd",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f66d2c5a-eb5a-4316-9649-373a76f9ba19",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5e4dc225-7cd5-43ea-8881-8f356ca48193",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cd00b815-f78e-484c-9931-1afa290524f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a947b571-da32-4440-89c4-6110ab6c6343",
"db_currency_id": "a35220b1-77b0-4e27-9845-5b2071aaf138",
"db_language_id": "cea27208-73e3-4f96-8819-7824222a540d",
"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": "2025-11-17T02:34:32.8350827+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-17T02:34:32.8507053+00:00"
},
"job_status_id": "68d12ac3-b8f1-406e-8c6a-ddb7be0609cd",
"job_status_code": "sample string 11",
"db_address_id": "e96985ee-98bf-43cb-80cd-fda923f03bac",
"contact_id": "5bcaf8c3-5704-42b6-b7ab-35325278a9c6",
"requested_by_company_id": "9f70e43a-991a-4d29-a553-70eaff67c0e3",
"requested_by_contact_id": "e50b4ee5-9af6-4306-b7a0-54ebaefcee07",
"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": "2025-11-17T02:34:32.8507053+00:00",
"due_date": "2025-11-17T02:34:32.8507053+00:00",
"date_create": "2025-11-17T02:34:32.8507053+00:00",
"date_update": "2025-11-17T02:34:32.8507053+00:00",
"date_closed": "2025-11-17T02:34:32.8507053+00:00",
"suggested_user_id": "e8fcd68e-d98b-4191-8105-e4174a1b21d8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4d41f19b-c687-40c7-80a0-4bae4fe690fb",
"db_language_id": "d19b4c64-0ef5-4e99-b8c3-124d3872d916",
"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": "2025-11-17T02:34:32.8507053+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "19c44fc9-a66f-48a2-acd8-40ff7ed09913",
"sales_organization": {
"id": "cd00b815-f78e-484c-9931-1afa290524f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a947b571-da32-4440-89c4-6110ab6c6343",
"db_currency_id": "a35220b1-77b0-4e27-9845-5b2071aaf138",
"db_language_id": "cea27208-73e3-4f96-8819-7824222a540d",
"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": "2025-11-17T02:34:32.8350827+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "435ec79c-7e2a-406d-9024-724e26936404",
"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": "cba573ed-ccb0-40fb-8796-14faaf16993d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-17T02:34:32.8507053+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "cedfb7b1-5b69-4b6d-b3c8-7001e8f03b3a"
},
"suggested_date_start": "2025-11-17T02:34:32.8507053+00:00",
"skill_id": "09548aa8-ee1d-41d3-91fe-71bc7f90c53f",
"skill_code": "sample string 32",
"skill": {
"id": "3fb6b35d-9fa1-493b-93f0-e6de041315e4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "454b53d0-50d0-4211-a03e-88e6f562cbd8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cd00b815-f78e-484c-9931-1afa290524f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a947b571-da32-4440-89c4-6110ab6c6343",
"db_currency_id": "a35220b1-77b0-4e27-9845-5b2071aaf138",
"db_language_id": "cea27208-73e3-4f96-8819-7824222a540d",
"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": "2025-11-17T02:34:32.8350827+00:00"
},
"modified_dateutc": "2025-11-17T02:34:32.8507053+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c41a7d77-b762-4a79-a83e-f42e665a5a2a",
"date_reported_by_company": "2025-11-17T02:34:32.8507053+00:00",
"id2": 36,
"company_id": "894e87df-b89a-4e4b-a1ae-616f52c3c0af",
"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": "f7d5d398-04d0-4a66-9955-dc157f91bdce",
"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": "2025-11-17T02:34:32.8507053+00:00"
},
"work_instruction_details_id": "5df6cc98-39fe-4287-a027-b6e5aac511c6",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "fe5ce821-49ec-44ef-9578-a43788f95f85",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d6193cc7-d10f-4d6a-b7cf-d9eca414fc33",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-17T02:34:32.8507053+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": "30abc150-984b-43dc-9ddd-2d2ee472b42e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-17T02:34:32.8663347+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.