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": "7e04b04e-259e-4813-a5fd-0b5ed674f325",
"jobs_id": "d8babcd8-c4e0-47f1-a64a-03f4b6438c0a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "41bf15c0-783a-469b-8199-127a239acd10",
"_parent_id": "19010986-03e5-4e3f-b22a-b59430d70193",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a678477b-0176-446a-9964-5e4539f4517a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f5116d96-f1ed-48e9-8334-544bff8410d1",
"_parent_id": "01637e61-c8dc-4ed0-b3bd-a03f73b63bb7",
"root_parent_id": "d300c215-9d81-40c1-8e9d-61c4bd0df8aa",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "536af903-060b-41c9-8aea-b1773abfee30",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "986ebecd-6d67-4b2a-86f4-d92db8c070a8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "96a44581-8cf9-42a3-a411-c3af40e759ff",
"_parent_code": "sample string 6",
"sales_organization_id": "d6a02ac5-9b44-4cd4-8f9d-12ba201ea47a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5801a5c6-9f5c-4fc3-83f4-d10544bd2d77",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e3fd6158-fb32-40ce-8eea-16e8559d741b",
"db_currency_id": "01c696f5-1b0f-4865-ab0e-0ac670b11074",
"db_language_id": "9b9b130f-0ddc-4487-9416-ec57e190f564",
"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-22T14:05:46.9073246+00:00"
},
"modified_dateutc": "2026-10-22T14:05:46.9073246+00:00"
},
"equipment_model_id": "d5fb4c91-7cf6-4f2a-95be-005ba15f1b3c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "da231447-c7e4-4975-b642-f09c6d4fa5d3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1184d51f-1dfc-409f-945f-f89ed4cece78",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "39caf56f-6d63-43a9-b9a7-1a968e4aa2ed",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "730b2133-6960-40a0-b82f-1ea30bbb1ce0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5801a5c6-9f5c-4fc3-83f4-d10544bd2d77",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e3fd6158-fb32-40ce-8eea-16e8559d741b",
"db_currency_id": "01c696f5-1b0f-4865-ab0e-0ac670b11074",
"db_language_id": "9b9b130f-0ddc-4487-9416-ec57e190f564",
"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-22T14:05:46.9073246+00:00"
},
"modified_dateutc": "2026-10-22T14:05:46.9073246+00:00"
},
"equipment_family_id": "b27efbc2-92b4-4684-88aa-4e858be71497",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "986ebecd-6d67-4b2a-86f4-d92db8c070a8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "96a44581-8cf9-42a3-a411-c3af40e759ff",
"_parent_code": "sample string 6",
"sales_organization_id": "d6a02ac5-9b44-4cd4-8f9d-12ba201ea47a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5801a5c6-9f5c-4fc3-83f4-d10544bd2d77",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e3fd6158-fb32-40ce-8eea-16e8559d741b",
"db_currency_id": "01c696f5-1b0f-4865-ab0e-0ac670b11074",
"db_language_id": "9b9b130f-0ddc-4487-9416-ec57e190f564",
"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-22T14:05:46.9073246+00:00"
},
"modified_dateutc": "2026-10-22T14:05:46.9073246+00:00"
},
"date_in_production_since": "2026-10-22T14:05:46.9073246+00:00",
"date_out_of_production_since": "2026-10-22T14:05:46.9073246+00:00",
"date_end_support": "2026-10-22T14:05:46.9073246+00:00",
"sales_organization_id": "8d18611f-de0c-4482-ad12-30c1a501cbb6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5801a5c6-9f5c-4fc3-83f4-d10544bd2d77",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e3fd6158-fb32-40ce-8eea-16e8559d741b",
"db_currency_id": "01c696f5-1b0f-4865-ab0e-0ac670b11074",
"db_language_id": "9b9b130f-0ddc-4487-9416-ec57e190f564",
"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-22T14:05:46.9073246+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-22T14:05:46.9271455+00:00"
},
"project_status_id": "39ac334a-aeaa-44a6-a712-63c0517897ca",
"project_status_code": "sample string 10",
"project_status": {
"id": "d1f25a25-e74f-45f2-ad38-736e97076eb3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "223df2ea-fbde-49d3-bcb2-50f9bfa0a4fb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5801a5c6-9f5c-4fc3-83f4-d10544bd2d77",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e3fd6158-fb32-40ce-8eea-16e8559d741b",
"db_currency_id": "01c696f5-1b0f-4865-ab0e-0ac670b11074",
"db_language_id": "9b9b130f-0ddc-4487-9416-ec57e190f564",
"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-22T14:05:46.9073246+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-22T14:05:46.9271455+00:00"
},
"company_id": "18c27837-5133-454d-895b-89b2749527eb",
"company_code": "sample string 12",
"db_address_id": "5fff7c77-87db-4d6b-935e-6c608917ebf2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d2ced59f-3fbe-465c-a43f-4efabaaf6bb4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "151f9e5d-cdcf-4fe2-9f64-de4251241f67",
"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-22T14:05:46.9271455+00:00",
"date_create": "2026-10-22T14:05:46.9271455+00:00",
"date_update": "2026-10-22T14:05:46.9271455+00:00",
"updated_by_user_id": "d70536af-9d1b-4667-ac0c-b9521804c637",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-22T14:05:46.9271455+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-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-22T14:05:46.9271455+00:00",
"date_last_job": "2026-10-22T14:05:46.9271455+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-22T14:05:46.9271455+00:00",
"modified_dateutc": "2026-10-22T14:05:46.9271455+00:00",
"is_mobile_installation": true
},
"job_type_id": "ff5576a7-d7da-4232-aa31-29a39a62cdcf",
"job_type_code": "sample string 7",
"job_type": {
"id": "f011de4f-d111-4f4a-a853-1ed5763e78f4",
"name": "sample string 2",
"sales_organization_id": "4c1afef9-e3de-4ada-8a40-cd4720adaa8c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-22T14:05:46.9271455+00:00",
"code": "sample string 7"
},
"job_priority_id": "caeb8bd3-3e31-42fe-bdba-b32771f1d5a7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ba66764c-39de-4c59-85de-77178a22ab37",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "bdbbc38d-3854-46a6-ad35-8e175a8f86b8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5801a5c6-9f5c-4fc3-83f4-d10544bd2d77",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e3fd6158-fb32-40ce-8eea-16e8559d741b",
"db_currency_id": "01c696f5-1b0f-4865-ab0e-0ac670b11074",
"db_language_id": "9b9b130f-0ddc-4487-9416-ec57e190f564",
"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-22T14:05:46.9073246+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-22T14:05:46.9271455+00:00"
},
"job_status_id": "c75b8b34-40b6-4af5-a5a5-360cac6f56f6",
"job_status_code": "sample string 11",
"db_address_id": "e690c235-721d-48d9-9eeb-6092b3f56b0b",
"contact_id": "bb2562ea-3047-45c6-be33-7ce8e1d5ce78",
"requested_by_company_id": "19684c11-42da-45f1-965a-bf4180600de3",
"requested_by_contact_id": "634c5956-7864-4383-91b7-bc50c3485df9",
"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-22T14:05:46.9271455+00:00",
"due_date": "2026-10-22T14:05:46.9271455+00:00",
"date_create": "2026-10-22T14:05:46.9271455+00:00",
"date_update": "2026-10-22T14:05:46.9271455+00:00",
"date_closed": "2026-10-22T14:05:46.9271455+00:00",
"suggested_user_id": "4e769e49-cad9-43fb-af00-1eeec943a0e9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "443e9703-539a-41da-b021-24da07950eec",
"db_language_id": "d9d4085b-22ba-4df1-9625-d41d83be1653",
"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-22T14:05:46.9271455+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d13417b3-bc61-4540-8303-a3655989edb2",
"sales_organization": {
"id": "5801a5c6-9f5c-4fc3-83f4-d10544bd2d77",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e3fd6158-fb32-40ce-8eea-16e8559d741b",
"db_currency_id": "01c696f5-1b0f-4865-ab0e-0ac670b11074",
"db_language_id": "9b9b130f-0ddc-4487-9416-ec57e190f564",
"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-22T14:05:46.9073246+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "919c7f54-e107-45dd-a6c3-beacea02194f",
"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": "5a68a4dd-86bc-498b-b82a-36a138f1f410",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-22T14:05:46.9271455+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1e95855a-99d7-41bc-8509-88e7a2ba4d87"
},
"suggested_date_start": "2026-10-22T14:05:46.9271455+00:00",
"skill_id": "6982315a-2e43-4933-a7fa-b0f724ec15bf",
"skill_code": "sample string 32",
"skill": {
"id": "ef0ab6d7-46a6-4815-82ad-8d5122b6a970",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "94c911fc-cb12-4a71-970f-437be4dccb30",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5801a5c6-9f5c-4fc3-83f4-d10544bd2d77",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e3fd6158-fb32-40ce-8eea-16e8559d741b",
"db_currency_id": "01c696f5-1b0f-4865-ab0e-0ac670b11074",
"db_language_id": "9b9b130f-0ddc-4487-9416-ec57e190f564",
"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-22T14:05:46.9073246+00:00"
},
"modified_dateutc": "2026-10-22T14:05:46.9271455+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b5b3384f-e831-428a-bdb7-f28ef7dc2419",
"date_reported_by_company": "2026-10-22T14:05:46.9271455+00:00",
"id2": 36,
"company_id": "415f41b3-d900-4845-99f9-f16215b1ddc0",
"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": "a7f22db5-5796-4c53-ac6b-7370ece23051",
"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-22T14:05:46.9271455+00:00"
},
"work_instruction_details_id": "3f602d3f-e444-4f63-afe4-80b067de9277",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "142f3ad7-4846-4573-8f76-3b20e99d0621",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "389ba9a8-ee34-4ea4-b70f-7b08ba1ddd65",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-22T14:05:46.9271455+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": "6d65757f-b407-41d6-a0e9-f6d6684cdf06",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-22T14:05:46.9378456+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.