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": "d562d750-1392-4e93-b6d2-eeb70640bcb6",
"jobs_id": "5ca707b5-f77a-469e-a22f-171d1a1189b2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e268abbf-d299-476e-b1d8-aa153ba04772",
"_parent_id": "f3da21a5-7165-41ff-9e2e-2445ace93834",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f9cdf859-3ae5-45c9-a836-9d1d8da03fee",
"project_reference_back_office": "sample string 5",
"project": {
"id": "51f95283-a082-4f2d-b9e7-1eba1a2c49e6",
"_parent_id": "f48ce5cb-5957-473d-aaef-915fc1f6c635",
"root_parent_id": "0ff53972-e3cf-4c6a-95ab-327245dd6926",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "82c8d3ce-ffa4-44c9-b72c-164786688d9e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3fa524a0-85f9-4aaf-841e-635028a6ce06",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2ed6bed7-9baa-4c50-9a4f-14c59641db86",
"_parent_code": "sample string 6",
"sales_organization_id": "7dfc9d97-fdc8-4124-8caa-0bfb4a08f1b1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d372ceb8-f66c-4176-88c9-8498f2045e44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2396f7f6-4a14-482c-a5fb-7272a1833497",
"db_currency_id": "c384301f-d43b-4bba-a2eb-db9f6541a56f",
"db_language_id": "efbf8a02-a7f5-4fc2-9185-0bdf8a4b54b7",
"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-15T07:26:14.1554557+00:00"
},
"modified_dateutc": "2026-10-15T07:26:14.1554557+00:00"
},
"equipment_model_id": "234ddaac-3210-464e-a5e6-574227fcadcd",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8dcc4fb3-55d8-443a-9670-c6c03cc5413e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c3461c62-bcbb-460c-8b4a-529cccada655",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3d57aca4-86ae-4f52-8dd6-0ebf4ca67c36",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "691bd629-16f8-461e-be58-67369d344b4e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d372ceb8-f66c-4176-88c9-8498f2045e44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2396f7f6-4a14-482c-a5fb-7272a1833497",
"db_currency_id": "c384301f-d43b-4bba-a2eb-db9f6541a56f",
"db_language_id": "efbf8a02-a7f5-4fc2-9185-0bdf8a4b54b7",
"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-15T07:26:14.1554557+00:00"
},
"modified_dateutc": "2026-10-15T07:26:14.1554557+00:00"
},
"equipment_family_id": "38f9bc85-d146-4ac4-8631-95a3228718d5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3fa524a0-85f9-4aaf-841e-635028a6ce06",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2ed6bed7-9baa-4c50-9a4f-14c59641db86",
"_parent_code": "sample string 6",
"sales_organization_id": "7dfc9d97-fdc8-4124-8caa-0bfb4a08f1b1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d372ceb8-f66c-4176-88c9-8498f2045e44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2396f7f6-4a14-482c-a5fb-7272a1833497",
"db_currency_id": "c384301f-d43b-4bba-a2eb-db9f6541a56f",
"db_language_id": "efbf8a02-a7f5-4fc2-9185-0bdf8a4b54b7",
"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-15T07:26:14.1554557+00:00"
},
"modified_dateutc": "2026-10-15T07:26:14.1554557+00:00"
},
"date_in_production_since": "2026-10-15T07:26:14.1554557+00:00",
"date_out_of_production_since": "2026-10-15T07:26:14.1554557+00:00",
"date_end_support": "2026-10-15T07:26:14.1554557+00:00",
"sales_organization_id": "ef091d9b-d0fd-4151-b104-2450664cf4b7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d372ceb8-f66c-4176-88c9-8498f2045e44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2396f7f6-4a14-482c-a5fb-7272a1833497",
"db_currency_id": "c384301f-d43b-4bba-a2eb-db9f6541a56f",
"db_language_id": "efbf8a02-a7f5-4fc2-9185-0bdf8a4b54b7",
"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-15T07:26:14.1554557+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-15T07:26:14.1554557+00:00"
},
"project_status_id": "bc9c6cfa-4e9e-46aa-b799-a6d44ebae6c8",
"project_status_code": "sample string 10",
"project_status": {
"id": "8cbd2fef-2f8f-47bd-8947-aaf1623461f6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "cffebea7-13cc-4e98-ad1f-eadafa003d40",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d372ceb8-f66c-4176-88c9-8498f2045e44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2396f7f6-4a14-482c-a5fb-7272a1833497",
"db_currency_id": "c384301f-d43b-4bba-a2eb-db9f6541a56f",
"db_language_id": "efbf8a02-a7f5-4fc2-9185-0bdf8a4b54b7",
"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-15T07:26:14.1554557+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-15T07:26:14.1554557+00:00"
},
"company_id": "1926da0a-2787-485c-8826-e2b3ea890fbd",
"company_code": "sample string 12",
"db_address_id": "e6dc6076-f0e8-42a7-a45e-7f81e34cf8c1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "22b5991c-67ef-418d-bc68-db5938c08d29",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6f6d062a-9825-4f0d-b1fa-2dcbc1af3607",
"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-15T07:26:14.1554557+00:00",
"date_create": "2026-10-15T07:26:14.1554557+00:00",
"date_update": "2026-10-15T07:26:14.1554557+00:00",
"updated_by_user_id": "135fb9a5-c575-4ee8-9cd4-3721e75ca6e7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-15T07:26:14.1554557+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-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-15T07:26:14.1554557+00:00",
"date_last_job": "2026-10-15T07:26:14.1554557+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-15T07:26:14.1554557+00:00",
"modified_dateutc": "2026-10-15T07:26:14.1554557+00:00",
"is_mobile_installation": true
},
"job_type_id": "1164f1ff-fc8b-40ff-a5bc-f60c9f309e9a",
"job_type_code": "sample string 7",
"job_type": {
"id": "dccd1667-940c-4cc6-9b77-1aea987aaabf",
"name": "sample string 2",
"sales_organization_id": "8bca4051-c003-4417-a890-e97b575666a9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-15T07:26:14.1554557+00:00",
"code": "sample string 7"
},
"job_priority_id": "2994d852-aea5-4ebf-99de-e7cd88ae4303",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c93fa16f-f18c-435a-b837-5bd86c0f1d6d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "33a91e6d-fbe5-4759-a121-6e5e6376d5c3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d372ceb8-f66c-4176-88c9-8498f2045e44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2396f7f6-4a14-482c-a5fb-7272a1833497",
"db_currency_id": "c384301f-d43b-4bba-a2eb-db9f6541a56f",
"db_language_id": "efbf8a02-a7f5-4fc2-9185-0bdf8a4b54b7",
"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-15T07:26:14.1554557+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-15T07:26:14.1554557+00:00"
},
"job_status_id": "3b062943-5082-4466-a2e2-e3ae9aca9218",
"job_status_code": "sample string 11",
"db_address_id": "1e26017e-80be-47b4-9ff4-9395994e5dd5",
"contact_id": "c102bc19-88a4-46bb-a96c-a79babc6aa20",
"requested_by_company_id": "8dade697-e1a6-4cbd-901c-5704d6896425",
"requested_by_contact_id": "6713e530-788d-449d-b23b-920897195ce6",
"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-15T07:26:14.1554557+00:00",
"due_date": "2026-10-15T07:26:14.1554557+00:00",
"date_create": "2026-10-15T07:26:14.1554557+00:00",
"date_update": "2026-10-15T07:26:14.1554557+00:00",
"date_closed": "2026-10-15T07:26:14.1554557+00:00",
"suggested_user_id": "361d2a54-b1f1-41e1-bc3a-421c48a52ef1",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a83a89fd-033f-4d6b-873d-aa5be4a08a0e",
"db_language_id": "f87ce732-676f-4315-b754-2f27d3f5f6fe",
"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-15T07:26:14.1554557+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1df11c67-e5e6-45a7-83db-8658bee87010",
"sales_organization": {
"id": "d372ceb8-f66c-4176-88c9-8498f2045e44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2396f7f6-4a14-482c-a5fb-7272a1833497",
"db_currency_id": "c384301f-d43b-4bba-a2eb-db9f6541a56f",
"db_language_id": "efbf8a02-a7f5-4fc2-9185-0bdf8a4b54b7",
"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-15T07:26:14.1554557+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "35995c7e-1052-4ee3-aea0-c9bd4f7ae42a",
"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": "7f227996-c2c9-4edd-9d38-c2ce64496713",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-15T07:26:14.1554557+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8d70458b-613c-4797-84c1-b704b9687ba2"
},
"suggested_date_start": "2026-10-15T07:26:14.1554557+00:00",
"skill_id": "d63d071c-6a96-4e30-8bde-4243dd106ce2",
"skill_code": "sample string 32",
"skill": {
"id": "114837a9-a333-4538-92c6-59b2fc7613e6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a4257a60-c464-4cc8-9970-eb7aa559e598",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d372ceb8-f66c-4176-88c9-8498f2045e44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2396f7f6-4a14-482c-a5fb-7272a1833497",
"db_currency_id": "c384301f-d43b-4bba-a2eb-db9f6541a56f",
"db_language_id": "efbf8a02-a7f5-4fc2-9185-0bdf8a4b54b7",
"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-15T07:26:14.1554557+00:00"
},
"modified_dateutc": "2026-10-15T07:26:14.1554557+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3e897675-ea02-4cd9-8b19-b541e87807a2",
"date_reported_by_company": "2026-10-15T07:26:14.1554557+00:00",
"id2": 36,
"company_id": "05946504-5a93-4844-b5d7-b9b17c391cb5",
"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": "43a37012-1e78-4f0b-a5db-6ca23a75629f",
"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-15T07:26:14.1554557+00:00"
},
"work_instruction_details_id": "035d4cb2-31f0-4538-bd6f-6e8ffc8106d1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "36999549-35d7-425c-ba38-43a240925f52",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a779a7aa-b1fe-41e3-ba75-3b0575c8f38d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-15T07:26:14.1554557+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": "5d289086-7f32-485b-8657-c268fcff88e8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-15T07:26:14.1554557+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.