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": "680d0034-ba4e-4c03-a292-c52dc964ae2d",
"jobs_id": "a87c11bd-02f9-418a-909e-255f57afbd61",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a056d641-5294-465b-b0b4-2137890f81b6",
"_parent_id": "39116b30-06d9-4dab-b8c6-673f3d6970de",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "91fc13cc-1e87-4b60-b2c5-87dd4e13f82d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "db148f11-aa36-45f9-a7a4-1c9977ec522d",
"_parent_id": "bf8adff2-6cd2-4eec-8824-2fd51a108f50",
"root_parent_id": "d5cf6813-844f-4c2a-85e4-92ba348d23b8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "83d86a07-6695-4895-b0ea-cf9b8856ad48",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e2cd9c68-9172-4249-806e-488f5cc7bc11",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4543fec8-f23a-4bc2-a660-d1faa149b9e3",
"_parent_code": "sample string 6",
"sales_organization_id": "acb285fe-42b8-4863-b711-a1f082eab9f4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "51edf3e7-4aee-444b-ba62-2f367b9d928e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5809f7f-f202-4a95-9d22-df92fb9ad413",
"db_currency_id": "5fa50bff-6654-470c-99a7-9c7cf06739ad",
"db_language_id": "abc24506-6663-420d-a255-1be4e305bc18",
"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-06-10T01:07:51.2141306+00:00"
},
"modified_dateutc": "2026-06-10T01:07:51.2141306+00:00"
},
"equipment_model_id": "b36724b1-b5b5-4bae-949c-8b2d61e1d430",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f602c0c2-89e3-4d2b-8a68-9e5bf2936f7a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ddc11090-db96-44f8-a933-c727c826a526",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4d80debe-5f02-46b5-9506-e099d95ec71e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "788d7029-4114-410c-b8a7-1abba5c5cbf3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "51edf3e7-4aee-444b-ba62-2f367b9d928e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5809f7f-f202-4a95-9d22-df92fb9ad413",
"db_currency_id": "5fa50bff-6654-470c-99a7-9c7cf06739ad",
"db_language_id": "abc24506-6663-420d-a255-1be4e305bc18",
"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-06-10T01:07:51.2141306+00:00"
},
"modified_dateutc": "2026-06-10T01:07:51.2141306+00:00"
},
"equipment_family_id": "ba4d1e73-0a11-441b-8aed-b51ccd8f4910",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e2cd9c68-9172-4249-806e-488f5cc7bc11",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4543fec8-f23a-4bc2-a660-d1faa149b9e3",
"_parent_code": "sample string 6",
"sales_organization_id": "acb285fe-42b8-4863-b711-a1f082eab9f4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "51edf3e7-4aee-444b-ba62-2f367b9d928e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5809f7f-f202-4a95-9d22-df92fb9ad413",
"db_currency_id": "5fa50bff-6654-470c-99a7-9c7cf06739ad",
"db_language_id": "abc24506-6663-420d-a255-1be4e305bc18",
"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-06-10T01:07:51.2141306+00:00"
},
"modified_dateutc": "2026-06-10T01:07:51.2141306+00:00"
},
"date_in_production_since": "2026-06-10T01:07:51.2141306+00:00",
"date_out_of_production_since": "2026-06-10T01:07:51.2141306+00:00",
"date_end_support": "2026-06-10T01:07:51.2141306+00:00",
"sales_organization_id": "83415889-3ab0-4183-9830-716c75e29175",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "51edf3e7-4aee-444b-ba62-2f367b9d928e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5809f7f-f202-4a95-9d22-df92fb9ad413",
"db_currency_id": "5fa50bff-6654-470c-99a7-9c7cf06739ad",
"db_language_id": "abc24506-6663-420d-a255-1be4e305bc18",
"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-06-10T01:07:51.2141306+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-06-10T01:07:51.2141306+00:00"
},
"project_status_id": "78b6fbff-90ef-4a99-bc14-cf97be133165",
"project_status_code": "sample string 10",
"project_status": {
"id": "801eca71-b81a-4e13-baa4-4e623830e1bc",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "27db14e3-5c3e-4d30-b05d-ad0ced18116e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "51edf3e7-4aee-444b-ba62-2f367b9d928e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5809f7f-f202-4a95-9d22-df92fb9ad413",
"db_currency_id": "5fa50bff-6654-470c-99a7-9c7cf06739ad",
"db_language_id": "abc24506-6663-420d-a255-1be4e305bc18",
"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-06-10T01:07:51.2141306+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-10T01:07:51.2141306+00:00"
},
"company_id": "83df53fc-9bc4-4656-b71c-d0207f8d8862",
"company_code": "sample string 12",
"db_address_id": "0aa01b3e-6547-405f-a826-3e6d23a86dc8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "570fe141-9dd7-4ab2-b8e8-b78aa1c2b2b1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e1f0eb44-0135-453e-bf51-580b5a83969a",
"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-06-10T01:07:51.2141306+00:00",
"date_create": "2026-06-10T01:07:51.2141306+00:00",
"date_update": "2026-06-10T01:07:51.2141306+00:00",
"updated_by_user_id": "9acfd378-4441-435e-a651-f6c58a780db0",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-10T01:07:51.2141306+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-06-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-10T01:07:51.2141306+00:00",
"date_last_job": "2026-06-10T01:07:51.2141306+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-10T01:07:51.2141306+00:00",
"modified_dateutc": "2026-06-10T01:07:51.2141306+00:00",
"is_mobile_installation": true
},
"job_type_id": "294ea06d-cef2-4de5-8a38-2b189b5b2e27",
"job_type_code": "sample string 7",
"job_type": {
"id": "d37864a8-dc50-4324-a200-f5176fedabe4",
"name": "sample string 2",
"sales_organization_id": "7a5d3b7b-7fd8-4cd2-990a-e1ed787f213e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-10T01:07:51.2141306+00:00",
"code": "sample string 7"
},
"job_priority_id": "e5b64772-5bda-4221-9899-afb37cd1c83e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "aca6677a-07d6-4d70-aeac-537b85e08d07",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "35f02ff5-4690-4345-818c-6baeccea031c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "51edf3e7-4aee-444b-ba62-2f367b9d928e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5809f7f-f202-4a95-9d22-df92fb9ad413",
"db_currency_id": "5fa50bff-6654-470c-99a7-9c7cf06739ad",
"db_language_id": "abc24506-6663-420d-a255-1be4e305bc18",
"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-06-10T01:07:51.2141306+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-10T01:07:51.2141306+00:00"
},
"job_status_id": "eec66196-50d0-416e-af11-5d0ddbffe332",
"job_status_code": "sample string 11",
"db_address_id": "fb795af3-2e75-4955-8b4e-7a449ac5865b",
"contact_id": "4a75b287-6363-4c5f-b060-db4a48b71389",
"requested_by_company_id": "1691e7ca-58fb-4fba-acf4-17890b240475",
"requested_by_contact_id": "91673ab8-5914-461b-9f5d-ad83cec0140a",
"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-06-10T01:07:51.2141306+00:00",
"due_date": "2026-06-10T01:07:51.2141306+00:00",
"date_create": "2026-06-10T01:07:51.2141306+00:00",
"date_update": "2026-06-10T01:07:51.2141306+00:00",
"date_closed": "2026-06-10T01:07:51.2141306+00:00",
"suggested_user_id": "e431c705-be6f-4aa2-858c-2cb15bf7a841",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0bf28a4f-82e4-4806-bfd1-e8f302278e3a",
"db_language_id": "ce25b978-dc3b-4a51-a545-5ff2de65ca96",
"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-06-10T01:07:51.2141306+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "262d3843-7832-4cb8-89eb-8f19c277a443",
"sales_organization": {
"id": "51edf3e7-4aee-444b-ba62-2f367b9d928e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5809f7f-f202-4a95-9d22-df92fb9ad413",
"db_currency_id": "5fa50bff-6654-470c-99a7-9c7cf06739ad",
"db_language_id": "abc24506-6663-420d-a255-1be4e305bc18",
"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-06-10T01:07:51.2141306+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "cadecb2d-1925-431d-8a8d-db4ac3a9fec4",
"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": "41b9c42f-d1e7-493f-953f-5d5d6e36aa22",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-10T01:07:51.2141306+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e4a7fab3-6a69-406f-b326-6e50cde6815e"
},
"suggested_date_start": "2026-06-10T01:07:51.2141306+00:00",
"skill_id": "2d77af9b-1de9-48f3-8276-55e275d8e295",
"skill_code": "sample string 32",
"skill": {
"id": "bbc17907-9012-4a97-822b-c652409730bd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6fd6eb97-2000-4639-8f6a-0f15a444624a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "51edf3e7-4aee-444b-ba62-2f367b9d928e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5809f7f-f202-4a95-9d22-df92fb9ad413",
"db_currency_id": "5fa50bff-6654-470c-99a7-9c7cf06739ad",
"db_language_id": "abc24506-6663-420d-a255-1be4e305bc18",
"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-06-10T01:07:51.2141306+00:00"
},
"modified_dateutc": "2026-06-10T01:07:51.2141306+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "30eb9228-cb59-4289-ade8-219d45e34373",
"date_reported_by_company": "2026-06-10T01:07:51.2141306+00:00",
"id2": 36,
"company_id": "e3803748-e407-4a0e-9ee0-96bf5f1095b4",
"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": "da097cbf-36ca-4b73-a07c-ff56c6e0429a",
"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-06-10T01:07:51.2141306+00:00"
},
"work_instruction_details_id": "e4ebb167-8782-492e-8b77-2141b960b4f3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "82928246-9a4f-4ff7-b1e5-e307dd8aa90c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a1e05549-d0c7-401e-8631-a5730b1bfcef",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-10T01:07:51.2141306+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": "f9f64383-e2c0-4997-bb3d-a460185188d8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-10T01:07:51.2141306+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.