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": "a2648b38-3bfa-4436-a256-3691615c2d59",
"jobs_id": "36f75921-98cc-48bc-acb7-6a908a87a1f8",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2c424a33-2c96-476d-8c89-ff47e2c77a5b",
"_parent_id": "911e6245-d0a8-4f0a-ad3a-9d00782017e3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0640720a-4bb4-46b8-9027-32607a273b42",
"project_reference_back_office": "sample string 5",
"project": {
"id": "68e15b0a-95d4-4add-9851-d36cc80c2d8e",
"_parent_id": "3705fe0d-421b-4774-b19c-863c4be9e6e5",
"root_parent_id": "af413a54-4112-426c-8651-53ea0eb7de2d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6e35a1f1-80b9-457a-b04a-9e593de50579",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2d713cad-42fc-4b0d-b617-e8020f53ebf9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "aeb9796a-bc0b-4fc3-af60-23ae267f0381",
"_parent_code": "sample string 6",
"sales_organization_id": "4f282488-4c1f-4f4b-8a5c-f3055e40324e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5bc7f64c-4b3a-4d04-955e-95a5ce7bc272",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ceb2a9d5-b527-4177-ae92-f5ab5db666d8",
"db_currency_id": "082e5fa9-8c1d-4ad6-a2f2-c48d0a316e94",
"db_language_id": "2c6ca331-699d-4f8e-81fa-047132cbf94d",
"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-05T04:45:27.9886458+00:00"
},
"modified_dateutc": "2026-10-05T04:45:27.9886458+00:00"
},
"equipment_model_id": "60541b98-5f4e-4566-bf46-6235d79dea7d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "56485e11-748b-449e-b9cc-d24484840850",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2a4fe8f2-c16e-42f8-85dd-ce88318f52f6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d46d3acd-dc8f-41ef-8f8c-a39b150fcb41",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "83921986-ae0e-4bcf-92c5-2edadef82007",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5bc7f64c-4b3a-4d04-955e-95a5ce7bc272",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ceb2a9d5-b527-4177-ae92-f5ab5db666d8",
"db_currency_id": "082e5fa9-8c1d-4ad6-a2f2-c48d0a316e94",
"db_language_id": "2c6ca331-699d-4f8e-81fa-047132cbf94d",
"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-05T04:45:27.9886458+00:00"
},
"modified_dateutc": "2026-10-05T04:45:27.9886458+00:00"
},
"equipment_family_id": "479154a5-f838-4324-9605-444a5915ea5f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2d713cad-42fc-4b0d-b617-e8020f53ebf9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "aeb9796a-bc0b-4fc3-af60-23ae267f0381",
"_parent_code": "sample string 6",
"sales_organization_id": "4f282488-4c1f-4f4b-8a5c-f3055e40324e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5bc7f64c-4b3a-4d04-955e-95a5ce7bc272",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ceb2a9d5-b527-4177-ae92-f5ab5db666d8",
"db_currency_id": "082e5fa9-8c1d-4ad6-a2f2-c48d0a316e94",
"db_language_id": "2c6ca331-699d-4f8e-81fa-047132cbf94d",
"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-05T04:45:27.9886458+00:00"
},
"modified_dateutc": "2026-10-05T04:45:27.9886458+00:00"
},
"date_in_production_since": "2026-10-05T04:45:27.9886458+00:00",
"date_out_of_production_since": "2026-10-05T04:45:27.9886458+00:00",
"date_end_support": "2026-10-05T04:45:27.9886458+00:00",
"sales_organization_id": "1ebe9c8a-2350-48f7-818c-ed1f52d94398",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5bc7f64c-4b3a-4d04-955e-95a5ce7bc272",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ceb2a9d5-b527-4177-ae92-f5ab5db666d8",
"db_currency_id": "082e5fa9-8c1d-4ad6-a2f2-c48d0a316e94",
"db_language_id": "2c6ca331-699d-4f8e-81fa-047132cbf94d",
"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-05T04:45:27.9886458+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-05T04:45:27.9886458+00:00"
},
"project_status_id": "0bd56554-790b-492e-9ced-dd6ca7ab1afb",
"project_status_code": "sample string 10",
"project_status": {
"id": "5923f36b-e801-4b81-ae0e-203a30287f98",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5b531d69-ef79-4286-9a80-3f3db45cabff",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5bc7f64c-4b3a-4d04-955e-95a5ce7bc272",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ceb2a9d5-b527-4177-ae92-f5ab5db666d8",
"db_currency_id": "082e5fa9-8c1d-4ad6-a2f2-c48d0a316e94",
"db_language_id": "2c6ca331-699d-4f8e-81fa-047132cbf94d",
"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-05T04:45:27.9886458+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-05T04:45:27.9886458+00:00"
},
"company_id": "14fd6a9b-0d06-47ae-8b38-c99a51620327",
"company_code": "sample string 12",
"db_address_id": "078c345b-3feb-408f-aa92-faea8f9d897f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b8e9258b-de61-4a75-819b-e5f9107c67c3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8c460868-f2db-4e2d-a891-23c2f0f320c4",
"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-05T04:45:27.9886458+00:00",
"date_create": "2026-10-05T04:45:27.9886458+00:00",
"date_update": "2026-10-05T04:45:27.9886458+00:00",
"updated_by_user_id": "6e9f5e33-c4b8-45d5-a376-4111ccc7124b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-05T04:45:27.9886458+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-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-05T04:45:27.9886458+00:00",
"date_last_job": "2026-10-05T04:45:27.9886458+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-05T04:45:27.9886458+00:00",
"modified_dateutc": "2026-10-05T04:45:27.9886458+00:00",
"is_mobile_installation": true
},
"job_type_id": "d321f04c-b2b3-4699-8fc7-69a30d45f631",
"job_type_code": "sample string 7",
"job_type": {
"id": "22ef6fa8-466d-462c-899f-018d238e50b9",
"name": "sample string 2",
"sales_organization_id": "c1aad70b-857b-4377-8a83-241f0f9331f9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-05T04:45:27.9886458+00:00",
"code": "sample string 7"
},
"job_priority_id": "e93da433-f40d-4479-8ac7-da0ec3502d21",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7cfdddd4-1ebb-435c-a39d-2c37a2cb28ef",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8fb76b0f-025f-4d9a-af63-769346037c88",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5bc7f64c-4b3a-4d04-955e-95a5ce7bc272",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ceb2a9d5-b527-4177-ae92-f5ab5db666d8",
"db_currency_id": "082e5fa9-8c1d-4ad6-a2f2-c48d0a316e94",
"db_language_id": "2c6ca331-699d-4f8e-81fa-047132cbf94d",
"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-05T04:45:27.9886458+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-05T04:45:27.9886458+00:00"
},
"job_status_id": "9232f02e-25fe-4534-8b0d-a901e1083ca6",
"job_status_code": "sample string 11",
"db_address_id": "0f5e8ff7-c99a-4b72-8bc0-7d4c778d855f",
"contact_id": "44caf368-bf24-469f-88ba-6fce7a51dd0f",
"requested_by_company_id": "d2ff3eba-f358-41b1-9a7b-6358945e7fa4",
"requested_by_contact_id": "d61c80dc-9723-40a9-9d3d-9aa964bfba68",
"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-05T04:45:27.9886458+00:00",
"due_date": "2026-10-05T04:45:27.9886458+00:00",
"date_create": "2026-10-05T04:45:27.9886458+00:00",
"date_update": "2026-10-05T04:45:27.9886458+00:00",
"date_closed": "2026-10-05T04:45:27.9886458+00:00",
"suggested_user_id": "6e4aaf29-8c92-4158-92a7-c7069e9cd9f4",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8e91a14e-4ee2-4ab2-b2ea-bb2fa5a339a7",
"db_language_id": "358b2114-0a8b-4bd5-97d1-195cceeaacbf",
"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-05T04:45:28.0058889+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a0d97cce-48f3-42db-b162-9e5416f65df8",
"sales_organization": {
"id": "5bc7f64c-4b3a-4d04-955e-95a5ce7bc272",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ceb2a9d5-b527-4177-ae92-f5ab5db666d8",
"db_currency_id": "082e5fa9-8c1d-4ad6-a2f2-c48d0a316e94",
"db_language_id": "2c6ca331-699d-4f8e-81fa-047132cbf94d",
"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-05T04:45:27.9886458+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b5dc72b6-6a30-488a-b27a-4c7d109e78e8",
"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": "56c36dba-2ccf-4ac1-a5e9-167b48180a83",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-05T04:45:28.0058889+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c6d0f9ab-439e-4ac5-908b-b43ccd346739"
},
"suggested_date_start": "2026-10-05T04:45:28.0058889+00:00",
"skill_id": "3dfbfe82-14f5-46f4-8bf6-63c3177fd571",
"skill_code": "sample string 32",
"skill": {
"id": "9c7c66b7-ddf6-4c9d-b636-698a081bed70",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "14e80d5b-c459-4fad-9ee1-da74a9a37f6f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5bc7f64c-4b3a-4d04-955e-95a5ce7bc272",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ceb2a9d5-b527-4177-ae92-f5ab5db666d8",
"db_currency_id": "082e5fa9-8c1d-4ad6-a2f2-c48d0a316e94",
"db_language_id": "2c6ca331-699d-4f8e-81fa-047132cbf94d",
"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-05T04:45:27.9886458+00:00"
},
"modified_dateutc": "2026-10-05T04:45:28.0058889+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ac5d3696-bef8-46b8-bf98-c9254af4f03e",
"date_reported_by_company": "2026-10-05T04:45:28.0058889+00:00",
"id2": 36,
"company_id": "02be0adc-443b-4dfa-b6be-304604f4368d",
"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": "55740054-e996-47f9-ac1b-b9d174ff6dbf",
"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-05T04:45:28.0058889+00:00"
},
"work_instruction_details_id": "084b80b2-f6db-4c41-8705-6d5e225a0f68",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "37009473-9a89-48ec-9e3f-44883c938762",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7cf72905-24b3-4858-980a-f3e7e1db4e17",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-05T04:45:28.0058889+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": "b60b1ebe-32c0-4ca5-b71e-25c8a2ad9915",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-05T04:45:28.0058889+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.