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": "49956a2c-8901-44a3-9bc5-7a42dbdf1563",
"jobs_id": "b5fb08ee-efae-40af-964b-a6416445d47d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "87c807cf-9345-445a-97ab-a2e13c69570c",
"_parent_id": "2e946d21-cccf-4378-8eaa-13b784dff120",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0819f74c-276f-49fa-bd93-16e8d1f3e10a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6a4614c4-1579-4f09-ac83-98acb099c575",
"_parent_id": "01ec780f-5b8a-48e0-89f4-979116735664",
"root_parent_id": "e94ab616-9fde-4121-bbc7-c751179799a6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "519f41b7-2735-4cad-b21f-538fdf3b4220",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "69a31dc8-5b21-418f-bcb3-b8306cec01eb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "72a0bd37-490b-42a7-9208-9938e83d2bd4",
"_parent_code": "sample string 6",
"sales_organization_id": "de6139ad-6edf-430b-844d-cbc6396e78b1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1a38a85f-67ed-4492-881c-baeee6de669d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0fc34f6c-b193-4c61-a04f-c9a6b2a01bb7",
"db_currency_id": "060720e2-4eb7-4e8d-b507-53f57241caa6",
"db_language_id": "63650e60-3638-4258-a299-149e698e7187",
"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-09-09T05:25:42.887992+00:00"
},
"modified_dateutc": "2026-09-09T05:25:42.887992+00:00"
},
"equipment_model_id": "5da03a49-9d58-4965-9d63-053bab360155",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7e1c7f5c-8c63-4279-9b43-6d46b95331e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3304241e-fbc7-4a02-9d3c-3e22ea489e05",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3c98c7ba-21e1-4f53-991b-16d5500a91b6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0f10c78c-69b5-4ca7-92da-8bd0c2eebe6b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1a38a85f-67ed-4492-881c-baeee6de669d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0fc34f6c-b193-4c61-a04f-c9a6b2a01bb7",
"db_currency_id": "060720e2-4eb7-4e8d-b507-53f57241caa6",
"db_language_id": "63650e60-3638-4258-a299-149e698e7187",
"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-09-09T05:25:42.887992+00:00"
},
"modified_dateutc": "2026-09-09T05:25:42.887992+00:00"
},
"equipment_family_id": "81be87e7-65ff-46fe-bb60-dba09c490fa7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "69a31dc8-5b21-418f-bcb3-b8306cec01eb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "72a0bd37-490b-42a7-9208-9938e83d2bd4",
"_parent_code": "sample string 6",
"sales_organization_id": "de6139ad-6edf-430b-844d-cbc6396e78b1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1a38a85f-67ed-4492-881c-baeee6de669d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0fc34f6c-b193-4c61-a04f-c9a6b2a01bb7",
"db_currency_id": "060720e2-4eb7-4e8d-b507-53f57241caa6",
"db_language_id": "63650e60-3638-4258-a299-149e698e7187",
"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-09-09T05:25:42.887992+00:00"
},
"modified_dateutc": "2026-09-09T05:25:42.887992+00:00"
},
"date_in_production_since": "2026-09-09T05:25:42.887992+00:00",
"date_out_of_production_since": "2026-09-09T05:25:42.887992+00:00",
"date_end_support": "2026-09-09T05:25:42.887992+00:00",
"sales_organization_id": "fe3e18c2-1312-45f4-8613-5ed85a142a8d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1a38a85f-67ed-4492-881c-baeee6de669d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0fc34f6c-b193-4c61-a04f-c9a6b2a01bb7",
"db_currency_id": "060720e2-4eb7-4e8d-b507-53f57241caa6",
"db_language_id": "63650e60-3638-4258-a299-149e698e7187",
"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-09-09T05:25:42.887992+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-09-09T05:25:42.887992+00:00"
},
"project_status_id": "da1fd6ce-74eb-4909-8fe7-6b42f1f7be69",
"project_status_code": "sample string 10",
"project_status": {
"id": "2594ce9f-93f8-491f-bd27-46e989366c04",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1c2e5a0a-a974-4c90-a8e2-ccf926cf4f89",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1a38a85f-67ed-4492-881c-baeee6de669d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0fc34f6c-b193-4c61-a04f-c9a6b2a01bb7",
"db_currency_id": "060720e2-4eb7-4e8d-b507-53f57241caa6",
"db_language_id": "63650e60-3638-4258-a299-149e698e7187",
"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-09-09T05:25:42.887992+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-09T05:25:42.887992+00:00"
},
"company_id": "b7e81b79-091a-4612-b67a-48239135c470",
"company_code": "sample string 12",
"db_address_id": "307cf0a3-c235-470c-bd35-454e4c77698b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a7e95897-2665-449d-b3d0-28a6312c97a0",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4e32641b-17b8-4023-9b18-cb9b43263b25",
"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-09-09T05:25:42.887992+00:00",
"date_create": "2026-09-09T05:25:42.887992+00:00",
"date_update": "2026-09-09T05:25:42.887992+00:00",
"updated_by_user_id": "14acdf8b-6b54-400e-b666-c30b04365700",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-09T05:25:42.887992+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-09-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-09T05:25:42.887992+00:00",
"date_last_job": "2026-09-09T05:25:42.887992+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-09T05:25:42.887992+00:00",
"modified_dateutc": "2026-09-09T05:25:42.887992+00:00",
"is_mobile_installation": true
},
"job_type_id": "fdcf0462-967e-4f80-9ed3-ae3197e367a8",
"job_type_code": "sample string 7",
"job_type": {
"id": "92c7eabf-e6fc-402c-a8f8-007b37f12767",
"name": "sample string 2",
"sales_organization_id": "81578398-49b7-430f-b16a-8a3910a8edf5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-09T05:25:42.887992+00:00",
"code": "sample string 7"
},
"job_priority_id": "f3d72a64-1a4f-48a0-a83d-a7945dce6c49",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a2f7e6f2-2cfb-4790-a3c1-39610d944f91",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "26858b76-db5b-47b1-8065-69f53f97d740",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1a38a85f-67ed-4492-881c-baeee6de669d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0fc34f6c-b193-4c61-a04f-c9a6b2a01bb7",
"db_currency_id": "060720e2-4eb7-4e8d-b507-53f57241caa6",
"db_language_id": "63650e60-3638-4258-a299-149e698e7187",
"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-09-09T05:25:42.887992+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-09T05:25:42.887992+00:00"
},
"job_status_id": "550b3779-a1c8-464b-928e-c228cdaa1329",
"job_status_code": "sample string 11",
"db_address_id": "374ea745-1e03-41e1-8c98-5cefbeca3175",
"contact_id": "03138532-801c-4ff7-97e3-edd1ad8940c7",
"requested_by_company_id": "c84668ee-a521-462e-9118-c3d57d2992bd",
"requested_by_contact_id": "cad640a3-53e9-47c8-99a0-6e549b0e873e",
"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-09-09T05:25:42.887992+00:00",
"due_date": "2026-09-09T05:25:42.887992+00:00",
"date_create": "2026-09-09T05:25:42.887992+00:00",
"date_update": "2026-09-09T05:25:42.887992+00:00",
"date_closed": "2026-09-09T05:25:42.887992+00:00",
"suggested_user_id": "8f88a10c-4b31-40fd-91d4-40339cbe4490",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "444fc223-897c-404d-b0da-e72175f7e0fc",
"db_language_id": "e53d908e-c670-48ed-ae50-58c1339f534f",
"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-09-09T05:25:42.887992+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c86395ec-a88d-4e07-a1a1-4c8ac0ca5d9c",
"sales_organization": {
"id": "1a38a85f-67ed-4492-881c-baeee6de669d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0fc34f6c-b193-4c61-a04f-c9a6b2a01bb7",
"db_currency_id": "060720e2-4eb7-4e8d-b507-53f57241caa6",
"db_language_id": "63650e60-3638-4258-a299-149e698e7187",
"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-09-09T05:25:42.887992+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1bd22eda-e94b-43e9-bb64-d19093542155",
"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": "6bcba775-bcef-4c0c-a9c1-0e8c238c6f7f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-09T05:25:42.887992+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ce377197-92e0-4b91-9625-27889eada6fc"
},
"suggested_date_start": "2026-09-09T05:25:42.887992+00:00",
"skill_id": "67fb1db2-9d1c-4e6f-bb14-e4aa8d436f4f",
"skill_code": "sample string 32",
"skill": {
"id": "b7f687a2-eb7d-4933-b243-4f7f86ae39c0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ca7c63fb-2217-426d-858c-e65763e6a920",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1a38a85f-67ed-4492-881c-baeee6de669d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0fc34f6c-b193-4c61-a04f-c9a6b2a01bb7",
"db_currency_id": "060720e2-4eb7-4e8d-b507-53f57241caa6",
"db_language_id": "63650e60-3638-4258-a299-149e698e7187",
"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-09-09T05:25:42.887992+00:00"
},
"modified_dateutc": "2026-09-09T05:25:42.887992+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d498a591-73fc-4117-b72a-5874657196d3",
"date_reported_by_company": "2026-09-09T05:25:42.887992+00:00",
"id2": 36,
"company_id": "8ff194cc-1683-4e24-bb91-65fc8dff20f4",
"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": "a0ac76a7-c9a8-42c4-89b5-14913265a902",
"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-09-09T05:25:42.887992+00:00"
},
"work_instruction_details_id": "a2e6cb93-98e5-46b0-bd8b-64b71aff1ef2",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2ab0b349-72d5-48e6-99f3-785a5e79feb1",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f4b4198a-5a2d-4209-9dbf-f6872d5ae4b1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-09T05:25:42.887992+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": "6044b23c-d537-4454-88f0-f80682e459d8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-09T05:25:42.887992+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.