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": "7a1e4c88-443b-47c3-a4e2-474e449f13b8",
"jobs_id": "b2cbdfff-8329-45dd-97b3-7a0ce0476897",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f8c504e9-0f0f-4147-b361-14f80bd83c61",
"_parent_id": "18f29bba-c1a6-4827-b14d-9911fafda1a3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3d3eaf17-a12c-466e-bf25-d885e3d95a93",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6a48fb70-aa2f-4817-9be9-cd909e223262",
"_parent_id": "5a218a52-a0db-4f9a-a628-acdb308a0f36",
"root_parent_id": "11f5f764-131b-43ac-8375-955dbfb19f12",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fb511480-f05d-4b24-97b7-6aa7db98949b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "48446521-ead0-4f49-8635-a8476e9104bd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b9adf48b-cd1c-4777-902a-45e77706dbb1",
"_parent_code": "sample string 6",
"sales_organization_id": "16bebc0c-dde5-4660-92b3-361f067e20a7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cfb57dc1-1816-4f1e-bf48-50af5bb891e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "616b7dd7-2529-4e7a-8d87-222c845728dc",
"db_currency_id": "4401f38d-8bcd-4814-a52a-bc18d8565273",
"db_language_id": "348bc0e2-9063-4418-9cd8-c263ce038c5b",
"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-05-29T20:29:07.0411006+00:00"
},
"modified_dateutc": "2026-05-29T20:29:07.0411006+00:00"
},
"equipment_model_id": "04b9aec2-9124-466e-bd1f-2ff736dc02c1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "113811f4-45f8-40cf-9c6e-5885096a93e5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "43b4ab4a-9e65-4d12-9077-db25974b568a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f9233f20-51ee-4323-a9fe-4c62b30d8c5d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "bcd801ff-da4b-47ba-82b1-064add955a34",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cfb57dc1-1816-4f1e-bf48-50af5bb891e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "616b7dd7-2529-4e7a-8d87-222c845728dc",
"db_currency_id": "4401f38d-8bcd-4814-a52a-bc18d8565273",
"db_language_id": "348bc0e2-9063-4418-9cd8-c263ce038c5b",
"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-05-29T20:29:07.0411006+00:00"
},
"modified_dateutc": "2026-05-29T20:29:07.0411006+00:00"
},
"equipment_family_id": "31fd7403-2dcc-46bd-a8d8-38dcddd2efa0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "48446521-ead0-4f49-8635-a8476e9104bd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b9adf48b-cd1c-4777-902a-45e77706dbb1",
"_parent_code": "sample string 6",
"sales_organization_id": "16bebc0c-dde5-4660-92b3-361f067e20a7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cfb57dc1-1816-4f1e-bf48-50af5bb891e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "616b7dd7-2529-4e7a-8d87-222c845728dc",
"db_currency_id": "4401f38d-8bcd-4814-a52a-bc18d8565273",
"db_language_id": "348bc0e2-9063-4418-9cd8-c263ce038c5b",
"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-05-29T20:29:07.0411006+00:00"
},
"modified_dateutc": "2026-05-29T20:29:07.0411006+00:00"
},
"date_in_production_since": "2026-05-29T20:29:07.0411006+00:00",
"date_out_of_production_since": "2026-05-29T20:29:07.0411006+00:00",
"date_end_support": "2026-05-29T20:29:07.0411006+00:00",
"sales_organization_id": "d73f113a-6999-41e2-9318-f90a17bbe825",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "cfb57dc1-1816-4f1e-bf48-50af5bb891e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "616b7dd7-2529-4e7a-8d87-222c845728dc",
"db_currency_id": "4401f38d-8bcd-4814-a52a-bc18d8565273",
"db_language_id": "348bc0e2-9063-4418-9cd8-c263ce038c5b",
"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-05-29T20:29:07.0411006+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-05-29T20:29:07.0411006+00:00"
},
"project_status_id": "d76bee9a-7194-480f-8b4b-74d2cafe07e6",
"project_status_code": "sample string 10",
"project_status": {
"id": "4df5b286-1b0c-42f1-94a1-646ee7add38d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d366177b-a810-474d-8cd3-2299108306eb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cfb57dc1-1816-4f1e-bf48-50af5bb891e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "616b7dd7-2529-4e7a-8d87-222c845728dc",
"db_currency_id": "4401f38d-8bcd-4814-a52a-bc18d8565273",
"db_language_id": "348bc0e2-9063-4418-9cd8-c263ce038c5b",
"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-05-29T20:29:07.0411006+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-29T20:29:07.0411006+00:00"
},
"company_id": "85efed76-8c5d-4598-8733-78ef68669ebd",
"company_code": "sample string 12",
"db_address_id": "01ab1b3c-cfe9-4177-b6ab-ed032021fdbf",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c7ea1989-45b7-4a9d-8ce9-f3f9b2f15971",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ef6d71f8-c8b4-495d-b32d-099ab5373466",
"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-05-29T20:29:07.0411006+00:00",
"date_create": "2026-05-29T20:29:07.0411006+00:00",
"date_update": "2026-05-29T20:29:07.0411006+00:00",
"updated_by_user_id": "0d223ee1-ddeb-43fb-9be3-c8affa79abf2",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-29T20:29:07.0411006+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-05-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-29T20:29:07.0411006+00:00",
"date_last_job": "2026-05-29T20:29:07.0411006+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-29T20:29:07.0411006+00:00",
"modified_dateutc": "2026-05-29T20:29:07.0411006+00:00",
"is_mobile_installation": true
},
"job_type_id": "fb17c2b8-9163-470a-91c6-bb8ff9597e03",
"job_type_code": "sample string 7",
"job_type": {
"id": "ea2e8f01-5719-45de-94e6-5a668ca2b76b",
"name": "sample string 2",
"sales_organization_id": "88941f8d-ed0c-4003-b326-6108bdec04c6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-29T20:29:07.0411006+00:00",
"code": "sample string 7"
},
"job_priority_id": "829b01cf-7be0-4336-8c3b-d375f956367a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2c1560fe-1b87-4825-8286-e9462c6c7d34",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3945d9c3-4e26-49b8-bda9-00c3f287fe70",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cfb57dc1-1816-4f1e-bf48-50af5bb891e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "616b7dd7-2529-4e7a-8d87-222c845728dc",
"db_currency_id": "4401f38d-8bcd-4814-a52a-bc18d8565273",
"db_language_id": "348bc0e2-9063-4418-9cd8-c263ce038c5b",
"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-05-29T20:29:07.0411006+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-29T20:29:07.0411006+00:00"
},
"job_status_id": "a755b06e-a260-4ca0-aa61-4a6dc76f2bca",
"job_status_code": "sample string 11",
"db_address_id": "6a50a896-9871-4f7a-8034-5029be983bb3",
"contact_id": "86b6c838-db77-4939-a628-8ea6b113cc3c",
"requested_by_company_id": "37fc8f2a-6645-4daf-8091-640feb010fbc",
"requested_by_contact_id": "9a469ba1-a33a-44b2-a2f8-581cf4f22f6d",
"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-05-29T20:29:07.0411006+00:00",
"due_date": "2026-05-29T20:29:07.0411006+00:00",
"date_create": "2026-05-29T20:29:07.0411006+00:00",
"date_update": "2026-05-29T20:29:07.0411006+00:00",
"date_closed": "2026-05-29T20:29:07.0411006+00:00",
"suggested_user_id": "2a5bc8f6-d0b8-498f-aab2-4cdc9a7310d6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "773e420f-a91e-415f-bd50-8407d18d4e2b",
"db_language_id": "32dc2d6e-6d7e-4441-afe8-fbccf34dc62b",
"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-05-29T20:29:07.0411006+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5521c312-9343-4a2c-918f-ea92d82ff073",
"sales_organization": {
"id": "cfb57dc1-1816-4f1e-bf48-50af5bb891e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "616b7dd7-2529-4e7a-8d87-222c845728dc",
"db_currency_id": "4401f38d-8bcd-4814-a52a-bc18d8565273",
"db_language_id": "348bc0e2-9063-4418-9cd8-c263ce038c5b",
"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-05-29T20:29:07.0411006+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c695b98a-b866-48f6-b819-20d1607e2a0c",
"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": "1f433f6e-4b68-43b1-b965-ca78c27c0f42",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-29T20:29:07.0411006+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "eb331cfa-bef5-4409-b8cf-08a0809f6369"
},
"suggested_date_start": "2026-05-29T20:29:07.0411006+00:00",
"skill_id": "cc2a9da4-96d4-426b-94e4-d8dfdcaf92a6",
"skill_code": "sample string 32",
"skill": {
"id": "9e6edcd8-115d-4238-a1ac-a2771f2fdd37",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9b148751-8e5f-4789-8334-c4129911f566",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cfb57dc1-1816-4f1e-bf48-50af5bb891e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "616b7dd7-2529-4e7a-8d87-222c845728dc",
"db_currency_id": "4401f38d-8bcd-4814-a52a-bc18d8565273",
"db_language_id": "348bc0e2-9063-4418-9cd8-c263ce038c5b",
"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-05-29T20:29:07.0411006+00:00"
},
"modified_dateutc": "2026-05-29T20:29:07.0411006+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3e449bbd-d38a-4319-8f8f-ebf31779de41",
"date_reported_by_company": "2026-05-29T20:29:07.0411006+00:00",
"id2": 36,
"company_id": "14c25223-2baa-4e93-91de-b84d788da800",
"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": "b32ceba6-027d-467b-a4ff-a33e3dee9d00",
"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-05-29T20:29:07.0411006+00:00"
},
"work_instruction_details_id": "18b48cb7-bdf6-4b22-b307-f0ebf8bfe86d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e4a7ea69-ce7c-4b18-988c-8010b06e2c33",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c34ab374-bd14-4262-8dc2-74dab3220ae5",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-29T20:29:07.0411006+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": "976c46ab-44fe-46bb-8896-90ffb7c6faf0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-29T20:29:07.0411006+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.