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": "5cb29439-a213-45ee-accb-d12afc2db7cd",
"jobs_id": "73b97424-eb54-4d09-83ad-a14bf006e028",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "db7b0496-1c58-4ae4-9bdc-e2e83e1a67b7",
"_parent_id": "3dd3406e-7d7b-4b3d-9f6f-2af3a516a4a6",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9647056e-f0e2-4ffa-ac3f-bee9ad0ab02e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4dae1fae-f173-4610-bea3-3cfb1f23d607",
"_parent_id": "18e1814a-aef2-463c-8f92-c90a02aa099f",
"root_parent_id": "9bf39310-a610-4bc2-a06c-a5eb35afc46e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "dbf404c4-19e8-44b0-ad22-965d1f116af8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "45f4c7f7-b746-4e10-803b-6ae17df3196f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "edcb4578-ac07-434c-b591-94c5fa9ce85b",
"_parent_code": "sample string 6",
"sales_organization_id": "1ae0f947-d38c-4e6c-a32e-700a5b63e2bb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "33e07ce9-2a27-448c-aee5-10517719b57c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "79c15dd2-1053-48c6-8938-36c245ca076a",
"db_currency_id": "b15247ad-0ff7-4437-abf2-eb1a005d7ea0",
"db_language_id": "27fa601e-18db-4ea2-83e5-f20259c94954",
"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-07T15:59:57.5279165+00:00"
},
"modified_dateutc": "2026-01-07T15:59:57.5279165+00:00"
},
"equipment_model_id": "1a84952d-ebb4-4d8e-b487-ada749633082",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f38b5cb0-3259-4d99-89e5-1805be671f97",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "dfdab15f-183b-49e3-9e39-bbb0b6ae888f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c06c030e-7c6b-441b-9ae4-5e3b26b58041",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "113f1d73-9a7e-4338-91e6-4f9bfde15294",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "33e07ce9-2a27-448c-aee5-10517719b57c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "79c15dd2-1053-48c6-8938-36c245ca076a",
"db_currency_id": "b15247ad-0ff7-4437-abf2-eb1a005d7ea0",
"db_language_id": "27fa601e-18db-4ea2-83e5-f20259c94954",
"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-07T15:59:57.5279165+00:00"
},
"modified_dateutc": "2026-01-07T15:59:57.5279165+00:00"
},
"equipment_family_id": "8927abc8-1265-40ff-822a-ad3e841cbb8a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "45f4c7f7-b746-4e10-803b-6ae17df3196f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "edcb4578-ac07-434c-b591-94c5fa9ce85b",
"_parent_code": "sample string 6",
"sales_organization_id": "1ae0f947-d38c-4e6c-a32e-700a5b63e2bb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "33e07ce9-2a27-448c-aee5-10517719b57c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "79c15dd2-1053-48c6-8938-36c245ca076a",
"db_currency_id": "b15247ad-0ff7-4437-abf2-eb1a005d7ea0",
"db_language_id": "27fa601e-18db-4ea2-83e5-f20259c94954",
"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-07T15:59:57.5279165+00:00"
},
"modified_dateutc": "2026-01-07T15:59:57.5279165+00:00"
},
"date_in_production_since": "2026-01-07T15:59:57.5279165+00:00",
"date_out_of_production_since": "2026-01-07T15:59:57.5279165+00:00",
"date_end_support": "2026-01-07T15:59:57.5279165+00:00",
"sales_organization_id": "58cc8a24-9285-479c-bd2c-751ce2e3c774",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "33e07ce9-2a27-448c-aee5-10517719b57c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "79c15dd2-1053-48c6-8938-36c245ca076a",
"db_currency_id": "b15247ad-0ff7-4437-abf2-eb1a005d7ea0",
"db_language_id": "27fa601e-18db-4ea2-83e5-f20259c94954",
"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-07T15:59:57.5279165+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-07T15:59:57.5279165+00:00"
},
"project_status_id": "96c5c441-8655-4b92-a9cd-ce0e36502e8d",
"project_status_code": "sample string 10",
"project_status": {
"id": "e5fdb387-ac7c-4c9d-8546-68a6b2e72758",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4eb0018b-248f-4c89-a3f0-44266c736d90",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "33e07ce9-2a27-448c-aee5-10517719b57c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "79c15dd2-1053-48c6-8938-36c245ca076a",
"db_currency_id": "b15247ad-0ff7-4437-abf2-eb1a005d7ea0",
"db_language_id": "27fa601e-18db-4ea2-83e5-f20259c94954",
"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-07T15:59:57.5279165+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-07T15:59:57.5279165+00:00"
},
"company_id": "813c6f14-01b1-4230-862b-e88e0692377d",
"company_code": "sample string 12",
"db_address_id": "fd2c9971-a74a-4188-a60c-46d34ddc036e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "91c3bc9a-9eae-4fca-8f77-403b1808758c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "31e9e700-0935-44f6-a703-da3dd8c16a45",
"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-07T15:59:57.5279165+00:00",
"date_create": "2026-01-07T15:59:57.5279165+00:00",
"date_update": "2026-01-07T15:59:57.5279165+00:00",
"updated_by_user_id": "45808880-539b-40ce-9652-6c882ac3cdd4",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-07T15:59:57.5279165+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-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-07T15:59:57.5279165+00:00",
"date_last_job": "2026-01-07T15:59:57.5279165+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-07T15:59:57.5279165+00:00",
"modified_dateutc": "2026-01-07T15:59:57.5279165+00:00",
"is_mobile_installation": true
},
"job_type_id": "f9d676c7-1f45-4b98-a043-3da510e7f283",
"job_type_code": "sample string 7",
"job_type": {
"id": "b464c2c0-9d1f-4aba-8f96-ccbd77346c2f",
"name": "sample string 2",
"sales_organization_id": "fdc29bb3-5d9f-40b3-a9e6-43640c0f6385",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-07T15:59:57.5279165+00:00",
"code": "sample string 7"
},
"job_priority_id": "140a7ebe-71a8-41a0-9964-064c3c1a7d30",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "27c0ce0f-ccdf-4291-84be-dfded761872c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "aeb009f2-08fa-4765-9208-e72b11e807f0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "33e07ce9-2a27-448c-aee5-10517719b57c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "79c15dd2-1053-48c6-8938-36c245ca076a",
"db_currency_id": "b15247ad-0ff7-4437-abf2-eb1a005d7ea0",
"db_language_id": "27fa601e-18db-4ea2-83e5-f20259c94954",
"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-07T15:59:57.5279165+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-07T15:59:57.5279165+00:00"
},
"job_status_id": "cc362338-a800-4b76-bc9f-7f36f3c2ce58",
"job_status_code": "sample string 11",
"db_address_id": "79c71397-550c-4564-ba94-5d85732d0aae",
"contact_id": "6d0c3286-4eed-4d0c-9ad6-cdc79811aaaa",
"requested_by_company_id": "79d0f880-659c-44d9-b032-072c4537bac5",
"requested_by_contact_id": "f02af052-5f1a-4e4c-8d18-3d3973de17e1",
"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-07T15:59:57.5279165+00:00",
"due_date": "2026-01-07T15:59:57.5279165+00:00",
"date_create": "2026-01-07T15:59:57.5279165+00:00",
"date_update": "2026-01-07T15:59:57.5279165+00:00",
"date_closed": "2026-01-07T15:59:57.5279165+00:00",
"suggested_user_id": "7e74d2d6-2a1b-409e-bd5c-59414699672f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7a6c7e96-8bf1-4ca1-a762-665b1858f9bb",
"db_language_id": "f5994df9-51bc-4e85-802f-59b7f3b56d3e",
"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-07T15:59:57.5279165+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7bb9eaf8-6e0f-4789-8be4-ca116cf54cf1",
"sales_organization": {
"id": "33e07ce9-2a27-448c-aee5-10517719b57c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "79c15dd2-1053-48c6-8938-36c245ca076a",
"db_currency_id": "b15247ad-0ff7-4437-abf2-eb1a005d7ea0",
"db_language_id": "27fa601e-18db-4ea2-83e5-f20259c94954",
"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-07T15:59:57.5279165+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "955d9112-fb5e-4aae-9174-74d81d0fffa7",
"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": "93076ec6-0311-4519-a82b-9110b2f4b6fb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-07T15:59:57.5279165+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7375bc14-6e86-4eaa-9fa0-48d427086540"
},
"suggested_date_start": "2026-01-07T15:59:57.5279165+00:00",
"skill_id": "fd180dc6-fadc-44d5-8702-9260d04af96c",
"skill_code": "sample string 32",
"skill": {
"id": "a12342fb-2a97-493f-9b33-a5c21673b42c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "bf3d1bef-a994-47ca-9748-d1f5a75de124",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "33e07ce9-2a27-448c-aee5-10517719b57c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "79c15dd2-1053-48c6-8938-36c245ca076a",
"db_currency_id": "b15247ad-0ff7-4437-abf2-eb1a005d7ea0",
"db_language_id": "27fa601e-18db-4ea2-83e5-f20259c94954",
"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-07T15:59:57.5279165+00:00"
},
"modified_dateutc": "2026-01-07T15:59:57.5279165+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4ffe53b4-811b-44e1-b23b-af47dbc12b94",
"date_reported_by_company": "2026-01-07T15:59:57.5279165+00:00",
"id2": 36,
"company_id": "4e709981-29ae-4e92-829f-26e1b73a2346",
"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": "f4e06ced-de19-4aef-b732-0476a79e3499",
"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-07T15:59:57.5279165+00:00"
},
"work_instruction_details_id": "694de1ea-0c82-4f31-a8a5-20bfa58f2e02",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2e97cf77-7fa4-46cb-903c-7d910a04f0f5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2b153a45-5fbb-46d2-ad5c-ec4bd360a05a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-07T15:59:57.5279165+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": "f689a2c8-3220-4346-8baf-b3f3cd66f28e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-07T15:59:57.5279165+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.