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": "ec431169-78ea-4048-a364-a7a7057d10f3",
"jobs_id": "a89cb49a-15d6-43a2-b6b4-07b36a2c0330",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9ec1c858-1082-443d-ad44-4cb8d705ccd8",
"_parent_id": "4ca7ea0a-a515-48ce-97a0-a9059c6608eb",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "91228994-2bd9-4f12-80f2-edd1dbd509d6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7c8e4571-636d-4660-8032-a0f7a15a74a5",
"_parent_id": "6ef5081d-0288-48e8-b67e-f438d5d54c46",
"root_parent_id": "9c261ed3-500f-42e7-b1f0-35a967545a0c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "57fd6650-d056-496c-89b6-1b82333806a0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f036ba1c-2a37-4ee6-b5df-931496fc3506",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a9801364-63c8-4ea7-8470-17544a2baccf",
"_parent_code": "sample string 6",
"sales_organization_id": "18550c18-660c-4a61-8edf-bf0cf4922c98",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4bd46f38-3143-40b6-b9ea-3cb22ba05bc1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90681ae6-3709-4867-8ea0-2ce8eff16090",
"db_currency_id": "9b47498e-b45b-4cd0-ad2f-b87c0d371a47",
"db_language_id": "0ef4eca6-da8c-4db1-8f28-7a95e1c4db58",
"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-01-10T00:11:41.2227724+00:00"
},
"modified_dateutc": "2026-01-10T00:11:41.2227724+00:00"
},
"equipment_model_id": "f05f8960-f8cf-4b37-be56-1ad4d1e35ab6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5d32064d-ffad-4c16-bbbd-69416e8225dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "06bf7a9a-db9c-4e21-8c87-499cc03fa732",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6cae6abf-6737-4ed2-ab25-72baa53310e5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "87921091-c905-4abe-8fe1-6be22ce4f071",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4bd46f38-3143-40b6-b9ea-3cb22ba05bc1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90681ae6-3709-4867-8ea0-2ce8eff16090",
"db_currency_id": "9b47498e-b45b-4cd0-ad2f-b87c0d371a47",
"db_language_id": "0ef4eca6-da8c-4db1-8f28-7a95e1c4db58",
"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-01-10T00:11:41.2227724+00:00"
},
"modified_dateutc": "2026-01-10T00:11:41.2227724+00:00"
},
"equipment_family_id": "e4da3e80-0de5-49b6-839c-b2c4e11072a6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f036ba1c-2a37-4ee6-b5df-931496fc3506",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a9801364-63c8-4ea7-8470-17544a2baccf",
"_parent_code": "sample string 6",
"sales_organization_id": "18550c18-660c-4a61-8edf-bf0cf4922c98",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4bd46f38-3143-40b6-b9ea-3cb22ba05bc1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90681ae6-3709-4867-8ea0-2ce8eff16090",
"db_currency_id": "9b47498e-b45b-4cd0-ad2f-b87c0d371a47",
"db_language_id": "0ef4eca6-da8c-4db1-8f28-7a95e1c4db58",
"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-01-10T00:11:41.2227724+00:00"
},
"modified_dateutc": "2026-01-10T00:11:41.2227724+00:00"
},
"date_in_production_since": "2026-01-10T00:11:41.2227724+00:00",
"date_out_of_production_since": "2026-01-10T00:11:41.2227724+00:00",
"date_end_support": "2026-01-10T00:11:41.2227724+00:00",
"sales_organization_id": "7ec5a339-706f-4e7a-adbe-e67e9f3e3f12",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4bd46f38-3143-40b6-b9ea-3cb22ba05bc1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90681ae6-3709-4867-8ea0-2ce8eff16090",
"db_currency_id": "9b47498e-b45b-4cd0-ad2f-b87c0d371a47",
"db_language_id": "0ef4eca6-da8c-4db1-8f28-7a95e1c4db58",
"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-01-10T00:11:41.2227724+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-01-10T00:11:41.2227724+00:00"
},
"project_status_id": "e4d7e9cf-3c98-42e5-82f7-57a2651cf419",
"project_status_code": "sample string 10",
"project_status": {
"id": "ffd2511a-a502-42f6-bc4b-28893bfdfb34",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "986f1437-15f7-445f-9e20-f436b2363367",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4bd46f38-3143-40b6-b9ea-3cb22ba05bc1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90681ae6-3709-4867-8ea0-2ce8eff16090",
"db_currency_id": "9b47498e-b45b-4cd0-ad2f-b87c0d371a47",
"db_language_id": "0ef4eca6-da8c-4db1-8f28-7a95e1c4db58",
"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-01-10T00:11:41.2227724+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-10T00:11:41.2227724+00:00"
},
"company_id": "ce44a1ee-9fdc-4079-9830-9a74b525e02b",
"company_code": "sample string 12",
"db_address_id": "63b9b6cf-cb6a-4432-830b-904d80b0f470",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ed2a8ac2-1cf1-4a29-bc30-c35a3889eb77",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1fe67a5d-6850-485a-a2d3-b99c05f3bad2",
"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-01-10T00:11:41.2227724+00:00",
"date_create": "2026-01-10T00:11:41.2227724+00:00",
"date_update": "2026-01-10T00:11:41.2227724+00:00",
"updated_by_user_id": "fa50f0c6-3d8f-4fca-916f-142e5790a3cb",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-10T00:11:41.2227724+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-01-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-10T00:11:41.2227724+00:00",
"date_last_job": "2026-01-10T00:11:41.2227724+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-10T00:11:41.2227724+00:00",
"modified_dateutc": "2026-01-10T00:11:41.2227724+00:00",
"is_mobile_installation": true
},
"job_type_id": "7deec9ab-4df6-44d7-98ea-c8d11cbb3201",
"job_type_code": "sample string 7",
"job_type": {
"id": "8e232feb-e3c2-4334-9903-7b37d2b57c9e",
"name": "sample string 2",
"sales_organization_id": "bf39dd8a-377a-4124-aade-9c4d32437282",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-10T00:11:41.2227724+00:00",
"code": "sample string 7"
},
"job_priority_id": "63fcd7fc-ebd2-4e60-a78f-07a04e5a7b78",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "04a4028c-f7a0-414b-86e5-c401f62dae85",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "75826884-3ff0-428f-a54d-233ee8fbde1d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4bd46f38-3143-40b6-b9ea-3cb22ba05bc1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90681ae6-3709-4867-8ea0-2ce8eff16090",
"db_currency_id": "9b47498e-b45b-4cd0-ad2f-b87c0d371a47",
"db_language_id": "0ef4eca6-da8c-4db1-8f28-7a95e1c4db58",
"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-01-10T00:11:41.2227724+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-10T00:11:41.2227724+00:00"
},
"job_status_id": "0c68b9c3-b5f4-4673-809e-b80557e0f16d",
"job_status_code": "sample string 11",
"db_address_id": "3a6addcd-ac74-4a94-afdd-a0e3db422eda",
"contact_id": "ef2e691b-1f1a-436e-b869-b3d1ffa46749",
"requested_by_company_id": "55008bd3-cc40-481f-a99c-79669f3a3c83",
"requested_by_contact_id": "cbdaa405-e430-4dd2-a69d-1f4d989f8a51",
"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-01-10T00:11:41.2227724+00:00",
"due_date": "2026-01-10T00:11:41.2227724+00:00",
"date_create": "2026-01-10T00:11:41.2227724+00:00",
"date_update": "2026-01-10T00:11:41.2227724+00:00",
"date_closed": "2026-01-10T00:11:41.2227724+00:00",
"suggested_user_id": "3e5c6c1b-af34-41bd-8014-a2400bd6df8e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "45b2a179-7f12-47c0-9ff5-904e140b48c2",
"db_language_id": "0837b67b-6bf3-43e3-b83e-e5329bcf8333",
"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-01-10T00:11:41.2227724+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4e8ea8db-caa2-4290-81c8-d9474f97b7d9",
"sales_organization": {
"id": "4bd46f38-3143-40b6-b9ea-3cb22ba05bc1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90681ae6-3709-4867-8ea0-2ce8eff16090",
"db_currency_id": "9b47498e-b45b-4cd0-ad2f-b87c0d371a47",
"db_language_id": "0ef4eca6-da8c-4db1-8f28-7a95e1c4db58",
"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-01-10T00:11:41.2227724+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6654797d-94b2-4ddc-bedd-a12c30d5df92",
"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": "b24e2005-e841-4a58-8726-5d6e6e7276b9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-10T00:11:41.2227724+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "19b7910e-0b93-403a-bf7d-44971d3d5707"
},
"suggested_date_start": "2026-01-10T00:11:41.2227724+00:00",
"skill_id": "0856794c-d759-400a-aa58-88792ee08789",
"skill_code": "sample string 32",
"skill": {
"id": "75862b9b-5e13-46ac-8c8a-c8035e68795f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e2d083d2-52c9-4fa5-9d39-acb613c2de0e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4bd46f38-3143-40b6-b9ea-3cb22ba05bc1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90681ae6-3709-4867-8ea0-2ce8eff16090",
"db_currency_id": "9b47498e-b45b-4cd0-ad2f-b87c0d371a47",
"db_language_id": "0ef4eca6-da8c-4db1-8f28-7a95e1c4db58",
"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-01-10T00:11:41.2227724+00:00"
},
"modified_dateutc": "2026-01-10T00:11:41.2227724+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "95d2b313-c9fe-4b3b-8f73-d33af48f1fdb",
"date_reported_by_company": "2026-01-10T00:11:41.2227724+00:00",
"id2": 36,
"company_id": "bb9e52f9-f5f2-45f8-b0e0-a42728371ec6",
"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": "66f2894b-3ba1-4ce0-9e21-2d189dea7907",
"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-01-10T00:11:41.2227724+00:00"
},
"work_instruction_details_id": "a51d60b2-017c-4f99-9781-4d9cfd989ad0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4b57cf28-cfb6-4c13-b214-1bca13e88924",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "73308a3a-8261-4c0c-9905-4ff80a948b6e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-10T00:11:41.2227724+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": "df007f37-fa70-48bd-aaf4-3c8bb1c9bcef",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-10T00:11:41.2227724+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.