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": "71e404f2-cd05-414e-a847-10ae4c1d48ae",
"jobs_id": "07460e4b-db42-4857-80ca-7c8d2ba04772",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "758afe84-b3f5-47c8-abc0-42c32fffba9b",
"_parent_id": "2a6cda93-3bc9-47f5-9264-a230b066b7e8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f7730939-e6e7-49f3-9940-142788a6838e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b6edf53e-d18c-4813-a3d9-6ab7b351ed3d",
"_parent_id": "e70071f3-2a02-4b0f-aba2-21a12130f7de",
"root_parent_id": "0f501f3e-9ce7-4086-a0d9-b9e114bf7df9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5cc91886-9870-4a92-9333-65df2fbd5b0b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2dc7efc2-814a-4b7b-9740-1b6f0d064351",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "da36ca9d-9a81-4541-9b59-4d1f5a2902aa",
"_parent_code": "sample string 6",
"sales_organization_id": "169d68ed-51bd-4d23-89e3-cc8641430b0a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9c5e4c2e-56ff-4445-b615-93b1734b660a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ab0482a-4b70-4b29-a6fe-eaa7e4074517",
"db_currency_id": "53626190-96fa-4f73-916a-0b37641fc79c",
"db_language_id": "baf9ebbf-3a8c-4f94-870b-887d9386ae17",
"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": "2025-11-15T11:45:03.4659961+00:00"
},
"modified_dateutc": "2025-11-15T11:45:03.4659961+00:00"
},
"equipment_model_id": "a4c3419b-6ba6-4b31-b509-98053181fc18",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "eb7e693b-6ab5-4a5d-a93d-83f8de3a46c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "bbd094aa-b487-4b6f-bf8a-914a97ceedbb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c37a10a1-073b-47e0-961b-8ec557580d13",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e8351b90-7a2f-47ef-b72f-50d1bf3b9ea9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9c5e4c2e-56ff-4445-b615-93b1734b660a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ab0482a-4b70-4b29-a6fe-eaa7e4074517",
"db_currency_id": "53626190-96fa-4f73-916a-0b37641fc79c",
"db_language_id": "baf9ebbf-3a8c-4f94-870b-887d9386ae17",
"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": "2025-11-15T11:45:03.4659961+00:00"
},
"modified_dateutc": "2025-11-15T11:45:03.4659961+00:00"
},
"equipment_family_id": "37529adf-13bb-4034-8451-a1094a01f7f6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2dc7efc2-814a-4b7b-9740-1b6f0d064351",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "da36ca9d-9a81-4541-9b59-4d1f5a2902aa",
"_parent_code": "sample string 6",
"sales_organization_id": "169d68ed-51bd-4d23-89e3-cc8641430b0a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9c5e4c2e-56ff-4445-b615-93b1734b660a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ab0482a-4b70-4b29-a6fe-eaa7e4074517",
"db_currency_id": "53626190-96fa-4f73-916a-0b37641fc79c",
"db_language_id": "baf9ebbf-3a8c-4f94-870b-887d9386ae17",
"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": "2025-11-15T11:45:03.4659961+00:00"
},
"modified_dateutc": "2025-11-15T11:45:03.4659961+00:00"
},
"date_in_production_since": "2025-11-15T11:45:03.4659961+00:00",
"date_out_of_production_since": "2025-11-15T11:45:03.4659961+00:00",
"date_end_support": "2025-11-15T11:45:03.4659961+00:00",
"sales_organization_id": "896160f8-00c6-4d95-a236-4af9676a647b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9c5e4c2e-56ff-4445-b615-93b1734b660a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ab0482a-4b70-4b29-a6fe-eaa7e4074517",
"db_currency_id": "53626190-96fa-4f73-916a-0b37641fc79c",
"db_language_id": "baf9ebbf-3a8c-4f94-870b-887d9386ae17",
"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": "2025-11-15T11:45:03.4659961+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": "2025-11-15T11:45:03.4659961+00:00"
},
"project_status_id": "45b9f863-3a3f-4127-bf14-9047f6a55c58",
"project_status_code": "sample string 10",
"project_status": {
"id": "b560008c-d3e9-4f15-97f7-ef37f607f44f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "58d9d045-d2f6-4748-8388-f2fd6f1bb6ff",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9c5e4c2e-56ff-4445-b615-93b1734b660a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ab0482a-4b70-4b29-a6fe-eaa7e4074517",
"db_currency_id": "53626190-96fa-4f73-916a-0b37641fc79c",
"db_language_id": "baf9ebbf-3a8c-4f94-870b-887d9386ae17",
"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": "2025-11-15T11:45:03.4659961+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-15T11:45:03.4816233+00:00"
},
"company_id": "8a649609-e2ac-426a-aa5c-e7b1b68a07a3",
"company_code": "sample string 12",
"db_address_id": "35da9d46-45c6-4a56-884a-3340358dba56",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "05e868ba-9c98-41c5-ae4c-8bb1b86ddce1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "90961745-943d-4213-91ad-dd6815d71203",
"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": "2025-11-15T11:45:03.4816233+00:00",
"date_create": "2025-11-15T11:45:03.4816233+00:00",
"date_update": "2025-11-15T11:45:03.4816233+00:00",
"updated_by_user_id": "01ffb8f4-68b0-4820-980e-231e261ff2a8",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-15T11:45:03.4816233+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": "2025-11-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-15T11:45:03.4816233+00:00",
"date_last_job": "2025-11-15T11:45:03.4816233+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-15T11:45:03.4816233+00:00",
"modified_dateutc": "2025-11-15T11:45:03.4816233+00:00",
"is_mobile_installation": true
},
"job_type_id": "82c9bfa5-5ab1-438c-838b-71820ea391cf",
"job_type_code": "sample string 7",
"job_type": {
"id": "a8003e12-0b6e-4152-87d5-d5048c900110",
"name": "sample string 2",
"sales_organization_id": "c644b512-d902-4a47-af6e-d2a2868143dd",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-15T11:45:03.4816233+00:00",
"code": "sample string 7"
},
"job_priority_id": "b1454c8f-dd5e-4450-be66-84cfa606d068",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "01674c5c-c477-4b66-8b5a-72d9de141599",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3af6c130-79b4-4208-a95f-bdc8c0e33ef7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9c5e4c2e-56ff-4445-b615-93b1734b660a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ab0482a-4b70-4b29-a6fe-eaa7e4074517",
"db_currency_id": "53626190-96fa-4f73-916a-0b37641fc79c",
"db_language_id": "baf9ebbf-3a8c-4f94-870b-887d9386ae17",
"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": "2025-11-15T11:45:03.4659961+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-15T11:45:03.4816233+00:00"
},
"job_status_id": "84bf9a90-d3ba-4562-9cc9-96ade35a75b2",
"job_status_code": "sample string 11",
"db_address_id": "b2853069-f522-4822-b4b2-295429231402",
"contact_id": "76f17784-855c-47de-83ba-7f04527ec90b",
"requested_by_company_id": "5b3002ad-e16f-4d04-8113-c0e5bada78bf",
"requested_by_contact_id": "cece5a57-59f6-4671-a319-c30a1065b4b4",
"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": "2025-11-15T11:45:03.4816233+00:00",
"due_date": "2025-11-15T11:45:03.4816233+00:00",
"date_create": "2025-11-15T11:45:03.4816233+00:00",
"date_update": "2025-11-15T11:45:03.4816233+00:00",
"date_closed": "2025-11-15T11:45:03.4816233+00:00",
"suggested_user_id": "5153d226-bee4-4ed7-81cf-c5a9b638b62d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2dc3f21c-73d6-4a1b-990c-ed6fb54efb1f",
"db_language_id": "2e0430b2-213c-4ba7-8596-f88d4157809b",
"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": "2025-11-15T11:45:03.4816233+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "590b1e7b-2672-43a8-b09a-bff2ee141fa3",
"sales_organization": {
"id": "9c5e4c2e-56ff-4445-b615-93b1734b660a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ab0482a-4b70-4b29-a6fe-eaa7e4074517",
"db_currency_id": "53626190-96fa-4f73-916a-0b37641fc79c",
"db_language_id": "baf9ebbf-3a8c-4f94-870b-887d9386ae17",
"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": "2025-11-15T11:45:03.4659961+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "cd2c9475-df77-4fd3-9b3e-63a05eec84cc",
"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": "a20a3e3b-3dc1-4831-85f5-b7bc78665c05",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-15T11:45:03.4816233+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b21f5445-f547-4283-8d57-48d209aebdd8"
},
"suggested_date_start": "2025-11-15T11:45:03.4816233+00:00",
"skill_id": "30a07efd-a689-41da-a191-da9f6b46feea",
"skill_code": "sample string 32",
"skill": {
"id": "63d9da15-3c81-4d0b-854b-c21af35ead8c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a958bb9e-7b9b-4065-a055-6250eafe9fda",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9c5e4c2e-56ff-4445-b615-93b1734b660a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ab0482a-4b70-4b29-a6fe-eaa7e4074517",
"db_currency_id": "53626190-96fa-4f73-916a-0b37641fc79c",
"db_language_id": "baf9ebbf-3a8c-4f94-870b-887d9386ae17",
"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": "2025-11-15T11:45:03.4659961+00:00"
},
"modified_dateutc": "2025-11-15T11:45:03.4816233+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0f3874f8-e0d0-4ecf-be3c-3009810fc657",
"date_reported_by_company": "2025-11-15T11:45:03.4816233+00:00",
"id2": 36,
"company_id": "1fe2830c-716a-4c1e-83af-4ae773c296c6",
"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": "fd4a2e18-9baf-4887-a139-5103c11de1b5",
"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": "2025-11-15T11:45:03.4816233+00:00"
},
"work_instruction_details_id": "73bf520e-0efe-49cd-8a9a-ac1d05d8f159",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b2ac49ac-8129-4817-a2db-7578d275d269",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "92e251bb-55fb-43fd-8763-626cf3109ec1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-15T11:45:03.4816233+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": "8c514de4-8e87-41f5-9b9d-1775e52e3f2a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-15T11:45:03.4816233+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.