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": "1f5261e4-a3a8-4d60-85e8-c226008a2344",
"jobs_id": "6c3e1063-aeec-4bd7-88bf-e77c6aa856fd",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "94923b0c-e6c9-4e12-b9c6-5ded71dde594",
"_parent_id": "8835ff9b-56c0-4b0b-877b-559930266716",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2b55fae4-b0cd-44a1-9edd-d700d14ea7ad",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0f9442f8-3ac2-4db2-8af4-49005f8cfc4e",
"_parent_id": "cd76b8dc-5452-451e-aba5-4d58cc5c4f86",
"root_parent_id": "f43a4e77-1821-43c1-9c82-93982c853945",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1f77de8f-7bfa-4253-824d-ade7d48c1994",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e049f925-ce4c-4497-8981-7735db31dcdb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d303549e-d16b-4ec3-bf50-89ce7e079d96",
"_parent_code": "sample string 6",
"sales_organization_id": "a617049b-173d-41ed-a636-ddd94de8d293",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "68a22f6a-9f25-4009-b256-04449a2a7b9c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7aa13b30-a51b-4cde-addd-89d94b809198",
"db_currency_id": "12c6558b-6a17-4c25-8953-d3c5ba3f14b9",
"db_language_id": "b9abae0f-b1b9-4022-8049-2f8ff33f61a7",
"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-09-22T08:11:44.9719818+00:00"
},
"modified_dateutc": "2026-09-22T08:11:44.9719818+00:00"
},
"equipment_model_id": "fb7a5ee1-5cc3-4d8b-a8ec-be12a88cef84",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "bd87457f-543e-421f-9297-c0043f369f7f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e2db5a7d-4de5-4a63-8ed4-cad4fd15cf6a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "12a06886-a8fc-4af2-b6fa-4e7c6f849402",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3b7e8372-ecc5-4206-97e0-a24490f5f11f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "68a22f6a-9f25-4009-b256-04449a2a7b9c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7aa13b30-a51b-4cde-addd-89d94b809198",
"db_currency_id": "12c6558b-6a17-4c25-8953-d3c5ba3f14b9",
"db_language_id": "b9abae0f-b1b9-4022-8049-2f8ff33f61a7",
"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-09-22T08:11:44.9719818+00:00"
},
"modified_dateutc": "2026-09-22T08:11:44.9719818+00:00"
},
"equipment_family_id": "925a051d-2246-4ffd-987e-2af685712d40",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e049f925-ce4c-4497-8981-7735db31dcdb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d303549e-d16b-4ec3-bf50-89ce7e079d96",
"_parent_code": "sample string 6",
"sales_organization_id": "a617049b-173d-41ed-a636-ddd94de8d293",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "68a22f6a-9f25-4009-b256-04449a2a7b9c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7aa13b30-a51b-4cde-addd-89d94b809198",
"db_currency_id": "12c6558b-6a17-4c25-8953-d3c5ba3f14b9",
"db_language_id": "b9abae0f-b1b9-4022-8049-2f8ff33f61a7",
"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-09-22T08:11:44.9719818+00:00"
},
"modified_dateutc": "2026-09-22T08:11:44.9719818+00:00"
},
"date_in_production_since": "2026-09-22T08:11:44.9719818+00:00",
"date_out_of_production_since": "2026-09-22T08:11:44.9719818+00:00",
"date_end_support": "2026-09-22T08:11:44.9719818+00:00",
"sales_organization_id": "c715e5ef-1ced-4538-b884-f5d8973d6428",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "68a22f6a-9f25-4009-b256-04449a2a7b9c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7aa13b30-a51b-4cde-addd-89d94b809198",
"db_currency_id": "12c6558b-6a17-4c25-8953-d3c5ba3f14b9",
"db_language_id": "b9abae0f-b1b9-4022-8049-2f8ff33f61a7",
"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-09-22T08:11:44.9719818+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-09-22T08:11:44.9719818+00:00"
},
"project_status_id": "c8d179bc-078d-40bc-a9c0-6009f8daffee",
"project_status_code": "sample string 10",
"project_status": {
"id": "d94249f8-f34d-4bbf-8c59-56bc94f21169",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3eac728e-6459-41ec-a162-19900292e67e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "68a22f6a-9f25-4009-b256-04449a2a7b9c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7aa13b30-a51b-4cde-addd-89d94b809198",
"db_currency_id": "12c6558b-6a17-4c25-8953-d3c5ba3f14b9",
"db_language_id": "b9abae0f-b1b9-4022-8049-2f8ff33f61a7",
"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-09-22T08:11:44.9719818+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-22T08:11:44.9719818+00:00"
},
"company_id": "96e85beb-e1ab-4cd5-b806-c9af6e981b4c",
"company_code": "sample string 12",
"db_address_id": "485639c3-c772-4535-8cfd-cd6adb10f564",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cd9d80b4-80ef-44ff-8974-4c9a56bdede7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0efc930c-bafa-4fea-ad8b-bf997412f8b5",
"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-09-22T08:11:44.9719818+00:00",
"date_create": "2026-09-22T08:11:44.9719818+00:00",
"date_update": "2026-09-22T08:11:44.9719818+00:00",
"updated_by_user_id": "2114929f-9586-479d-9fc1-80c5c79445cc",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-22T08:11:44.9719818+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-09-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-22T08:11:44.9719818+00:00",
"date_last_job": "2026-09-22T08:11:44.9719818+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-22T08:11:44.9719818+00:00",
"modified_dateutc": "2026-09-22T08:11:44.9719818+00:00",
"is_mobile_installation": true
},
"job_type_id": "f243435e-142b-4b52-878a-a1c66fb2187f",
"job_type_code": "sample string 7",
"job_type": {
"id": "27335551-97d9-4d0e-a1a5-0175b447df16",
"name": "sample string 2",
"sales_organization_id": "facb442d-ea10-4828-a557-6289fcdf026d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-22T08:11:44.9719818+00:00",
"code": "sample string 7"
},
"job_priority_id": "0e697573-a914-4b65-85f4-426398f21bf1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "31a1747a-83e4-4294-b78e-46d32b4d6c71",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "feca6918-cbeb-4d41-9e93-ae4d218099bf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "68a22f6a-9f25-4009-b256-04449a2a7b9c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7aa13b30-a51b-4cde-addd-89d94b809198",
"db_currency_id": "12c6558b-6a17-4c25-8953-d3c5ba3f14b9",
"db_language_id": "b9abae0f-b1b9-4022-8049-2f8ff33f61a7",
"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-09-22T08:11:44.9719818+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-22T08:11:44.9719818+00:00"
},
"job_status_id": "b279719c-ddcd-49bc-b25c-64e86616bf7e",
"job_status_code": "sample string 11",
"db_address_id": "e754b177-e0d3-4d49-bb85-84cd542b29dc",
"contact_id": "7ec78884-86f4-4da3-8508-5c6b148364b9",
"requested_by_company_id": "d4148a88-5d1c-4b51-9e71-70d25c079060",
"requested_by_contact_id": "a597f454-2b29-4d1e-8f65-a2d10d4149c9",
"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-09-22T08:11:44.9719818+00:00",
"due_date": "2026-09-22T08:11:44.9719818+00:00",
"date_create": "2026-09-22T08:11:44.9719818+00:00",
"date_update": "2026-09-22T08:11:44.9719818+00:00",
"date_closed": "2026-09-22T08:11:44.9719818+00:00",
"suggested_user_id": "87f9326c-f65c-4d29-9934-dd7c4d51e767",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7145f6a4-1ad4-433e-a6aa-0e275df3d3d8",
"db_language_id": "61592b87-76a0-40ba-add6-6a70f39742bf",
"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-09-22T08:11:44.9719818+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "79221ece-9c06-45d6-bfe3-f9c14fe9071a",
"sales_organization": {
"id": "68a22f6a-9f25-4009-b256-04449a2a7b9c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7aa13b30-a51b-4cde-addd-89d94b809198",
"db_currency_id": "12c6558b-6a17-4c25-8953-d3c5ba3f14b9",
"db_language_id": "b9abae0f-b1b9-4022-8049-2f8ff33f61a7",
"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-09-22T08:11:44.9719818+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1a06e43f-240f-4792-90ed-9d2407f0657c",
"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": "5352aaaf-75d4-4ba8-b3c4-218221131bc6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-22T08:11:44.9719818+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a8c3ddab-ae86-4e03-a7da-d6f308c733a6"
},
"suggested_date_start": "2026-09-22T08:11:44.9719818+00:00",
"skill_id": "61d0d663-f775-4217-91f5-17eca35db964",
"skill_code": "sample string 32",
"skill": {
"id": "e5ac5ecb-baff-4bff-87d3-3d676c203b9d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "bfd669cc-dc92-4829-ae61-7bdb6751bb71",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "68a22f6a-9f25-4009-b256-04449a2a7b9c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7aa13b30-a51b-4cde-addd-89d94b809198",
"db_currency_id": "12c6558b-6a17-4c25-8953-d3c5ba3f14b9",
"db_language_id": "b9abae0f-b1b9-4022-8049-2f8ff33f61a7",
"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-09-22T08:11:44.9719818+00:00"
},
"modified_dateutc": "2026-09-22T08:11:44.9719818+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5cd797b7-dcc9-4c7c-9905-f716f9287e77",
"date_reported_by_company": "2026-09-22T08:11:44.9719818+00:00",
"id2": 36,
"company_id": "6b9f85b0-58c3-411e-a0f5-bd561fdd4959",
"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": "8cafb4e3-f529-4345-bba2-572e7a8660a2",
"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-09-22T08:11:44.9719818+00:00"
},
"work_instruction_details_id": "f5fc0e88-168f-40da-94b9-3d3789ad7717",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9b88d30b-911b-414b-a817-5a458b271b1c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c76f8646-4d61-4972-a127-bdeb4bc3c2c7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-22T08:11:44.9719818+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": "82ddb809-fcdb-43f1-8485-990aab0562c5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-22T08:11:44.9719818+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.