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": "9e592491-76e0-4906-82e0-c503c4d21918",
"jobs_id": "3c14942e-3598-4fcb-8d10-6d8145f5d9ec",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0242eaba-10bb-4136-bac1-7ec0fcb372c0",
"_parent_id": "ada40cd6-fdb6-4d25-9307-26af3a195269",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "012177bf-f0f3-45f9-93c9-940ef0696436",
"project_reference_back_office": "sample string 5",
"project": {
"id": "cdf1fb2c-baa7-426a-8ab3-91a00f351238",
"_parent_id": "e71e6817-1fd8-4203-bbe3-d8a4ba5ef546",
"root_parent_id": "f37a4ba8-aa9b-46f3-85cf-2eb90a917124",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9a6db3fc-8c0c-4e11-803f-43b1cc026a37",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9cebe48d-33b8-49d1-9127-685dcc793295",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fb7f7f3d-9f3b-40d4-95cf-d17caef33762",
"_parent_code": "sample string 6",
"sales_organization_id": "59ebd65a-f4d6-4391-8204-22c7bbc301b4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0ffb4733-4686-4dd9-9cc1-bfa6aab66377",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "327151a5-2571-41c7-813b-7373f7721af8",
"db_currency_id": "d0f03b98-dd80-42c5-9fb4-34de64c4e8dd",
"db_language_id": "96b8c209-5d83-4aba-a815-bdc81ad5abf0",
"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-12-04T14:09:31.4832867+00:00"
},
"modified_dateutc": "2025-12-04T14:09:31.4832867+00:00"
},
"equipment_model_id": "3d285096-9608-4156-b254-6e18a511f345",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7bb7a46c-c84e-406c-83f0-7793daddc22a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "39c62ae4-8db2-456e-9bc7-6ca21977d2a2",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "24a3c462-6b4b-4f97-9875-7966098a665e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "64c9a21e-6f2d-4a10-a198-31fbe2f5708b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0ffb4733-4686-4dd9-9cc1-bfa6aab66377",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "327151a5-2571-41c7-813b-7373f7721af8",
"db_currency_id": "d0f03b98-dd80-42c5-9fb4-34de64c4e8dd",
"db_language_id": "96b8c209-5d83-4aba-a815-bdc81ad5abf0",
"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-12-04T14:09:31.4832867+00:00"
},
"modified_dateutc": "2025-12-04T14:09:31.4832867+00:00"
},
"equipment_family_id": "3a3a4f3b-f453-4bb5-b492-6fce6c207f2d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9cebe48d-33b8-49d1-9127-685dcc793295",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fb7f7f3d-9f3b-40d4-95cf-d17caef33762",
"_parent_code": "sample string 6",
"sales_organization_id": "59ebd65a-f4d6-4391-8204-22c7bbc301b4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0ffb4733-4686-4dd9-9cc1-bfa6aab66377",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "327151a5-2571-41c7-813b-7373f7721af8",
"db_currency_id": "d0f03b98-dd80-42c5-9fb4-34de64c4e8dd",
"db_language_id": "96b8c209-5d83-4aba-a815-bdc81ad5abf0",
"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-12-04T14:09:31.4832867+00:00"
},
"modified_dateutc": "2025-12-04T14:09:31.4832867+00:00"
},
"date_in_production_since": "2025-12-04T14:09:31.4832867+00:00",
"date_out_of_production_since": "2025-12-04T14:09:31.4832867+00:00",
"date_end_support": "2025-12-04T14:09:31.4832867+00:00",
"sales_organization_id": "b5c649fa-d54f-44a9-a031-5025c96c0f42",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0ffb4733-4686-4dd9-9cc1-bfa6aab66377",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "327151a5-2571-41c7-813b-7373f7721af8",
"db_currency_id": "d0f03b98-dd80-42c5-9fb4-34de64c4e8dd",
"db_language_id": "96b8c209-5d83-4aba-a815-bdc81ad5abf0",
"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-12-04T14:09:31.4832867+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-12-04T14:09:31.4832867+00:00"
},
"project_status_id": "a7996101-efdd-436e-af63-3eb6858987c5",
"project_status_code": "sample string 10",
"project_status": {
"id": "b2385db2-62e1-4e44-b462-b0011172f6d9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9a761b6f-9e97-4332-aefb-10c2b910131b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0ffb4733-4686-4dd9-9cc1-bfa6aab66377",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "327151a5-2571-41c7-813b-7373f7721af8",
"db_currency_id": "d0f03b98-dd80-42c5-9fb4-34de64c4e8dd",
"db_language_id": "96b8c209-5d83-4aba-a815-bdc81ad5abf0",
"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-12-04T14:09:31.4832867+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-04T14:09:31.4832867+00:00"
},
"company_id": "97447db7-1c62-4109-9059-c917a549baad",
"company_code": "sample string 12",
"db_address_id": "048cfab9-bd7b-4158-b745-1ee1bcb23c59",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f166e548-373f-4c8c-957b-8e95da8113f9",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "404a6397-b102-41b5-a86a-0531ec23cd58",
"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-12-04T14:09:31.4832867+00:00",
"date_create": "2025-12-04T14:09:31.4832867+00:00",
"date_update": "2025-12-04T14:09:31.4832867+00:00",
"updated_by_user_id": "468d776c-ef10-4584-9b71-b4a1982978ec",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-04T14:09:31.4832867+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-12-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-04T14:09:31.4832867+00:00",
"date_last_job": "2025-12-04T14:09:31.4832867+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-04T14:09:31.4832867+00:00",
"modified_dateutc": "2025-12-04T14:09:31.4832867+00:00",
"is_mobile_installation": true
},
"job_type_id": "c139432e-d113-41a8-bf37-50468bb0be5f",
"job_type_code": "sample string 7",
"job_type": {
"id": "71c568c0-9bcb-4445-aeb7-77d9f42d638b",
"name": "sample string 2",
"sales_organization_id": "9b192aa5-15ff-4106-b014-eebba10f2ad0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-04T14:09:31.4832867+00:00",
"code": "sample string 7"
},
"job_priority_id": "7ecd3263-b158-4226-bef8-64e0ea3bd87c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3f75d3d6-64f0-4ba2-9034-7a580990f6b9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "980c7c90-6636-462e-932f-5ee483c9b92c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0ffb4733-4686-4dd9-9cc1-bfa6aab66377",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "327151a5-2571-41c7-813b-7373f7721af8",
"db_currency_id": "d0f03b98-dd80-42c5-9fb4-34de64c4e8dd",
"db_language_id": "96b8c209-5d83-4aba-a815-bdc81ad5abf0",
"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-12-04T14:09:31.4832867+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-04T14:09:31.4832867+00:00"
},
"job_status_id": "675f7bc7-d313-4a46-bce3-7b0d745fef96",
"job_status_code": "sample string 11",
"db_address_id": "d8f6b439-7b93-463f-8f07-c4c4740e4542",
"contact_id": "76fb1c0b-4c9c-4ac4-b3d5-04d28acc9abe",
"requested_by_company_id": "a62cbea7-75ed-441c-835f-ef8a78733382",
"requested_by_contact_id": "d4756094-6a49-4065-996a-869b8e7ed78b",
"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-12-04T14:09:31.4832867+00:00",
"due_date": "2025-12-04T14:09:31.4832867+00:00",
"date_create": "2025-12-04T14:09:31.4832867+00:00",
"date_update": "2025-12-04T14:09:31.4832867+00:00",
"date_closed": "2025-12-04T14:09:31.4832867+00:00",
"suggested_user_id": "ccad8ef0-e72f-4793-9f4a-afa2d0988d74",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e2434a5a-1989-40e7-80ea-6a4b45c0e2ca",
"db_language_id": "67b34bd7-96cc-4510-b159-33897e3bd60c",
"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-12-04T14:09:31.4832867+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "335e52c8-14cb-4eba-83fb-f8ccb1cdd1bf",
"sales_organization": {
"id": "0ffb4733-4686-4dd9-9cc1-bfa6aab66377",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "327151a5-2571-41c7-813b-7373f7721af8",
"db_currency_id": "d0f03b98-dd80-42c5-9fb4-34de64c4e8dd",
"db_language_id": "96b8c209-5d83-4aba-a815-bdc81ad5abf0",
"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-12-04T14:09:31.4832867+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "48b7d0a7-283a-46e3-9bcc-78362ace1321",
"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": "4615c177-3ef0-4a57-8d40-6b990da9e3ae",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-04T14:09:31.4832867+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0645a6e1-88a4-4f8b-86f8-aa04c6ff8411"
},
"suggested_date_start": "2025-12-04T14:09:31.4832867+00:00",
"skill_id": "18f8bec7-eda5-4158-a605-6a612cbe0b41",
"skill_code": "sample string 32",
"skill": {
"id": "779b812a-aa69-451a-88aa-2aebb35a91df",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b436b6f4-acab-4047-82d0-11610bdfb4ef",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0ffb4733-4686-4dd9-9cc1-bfa6aab66377",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "327151a5-2571-41c7-813b-7373f7721af8",
"db_currency_id": "d0f03b98-dd80-42c5-9fb4-34de64c4e8dd",
"db_language_id": "96b8c209-5d83-4aba-a815-bdc81ad5abf0",
"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-12-04T14:09:31.4832867+00:00"
},
"modified_dateutc": "2025-12-04T14:09:31.4832867+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3d6668ad-d056-4d7d-bffc-75b79f7f875f",
"date_reported_by_company": "2025-12-04T14:09:31.4832867+00:00",
"id2": 36,
"company_id": "057865fa-aae2-4527-8ffa-7053b03760ae",
"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": "50899636-1abe-42ad-915e-6aa34bb5774e",
"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-12-04T14:09:31.4832867+00:00"
},
"work_instruction_details_id": "fb51da75-c7a5-4171-81fa-acc14b0e8d83",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1ff09647-fd4c-4d73-9fbd-909b2721ff00",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "00a279e8-3259-40a4-b2ab-4d5aea65e713",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-04T14:09:31.4987742+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": "92f28f33-288b-4c6f-aafb-9d06ed16bd53",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-04T14:09:31.4987742+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.