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": "d875321b-0fe9-4a8b-a86f-24591ef10e80",
"jobs_id": "c1bf36d1-f6bb-4f89-b02e-46e87c0bd975",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f3c1ddd1-0214-45b1-9c80-e26f3abd0a8f",
"_parent_id": "d1910a4d-42d0-4282-b0db-1233bf5e7e89",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3c8cfeb7-987d-408d-baba-335ba803b171",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3eacdb1e-312f-4e19-9c7a-de2fed9b99bb",
"_parent_id": "3b44f681-b054-4a60-8b09-ddcc9850b7f5",
"root_parent_id": "309b81df-dcb5-41cd-8852-596dcbdf3122",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "84fee5ba-36db-451a-b8b4-673460436717",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "61517f5a-395a-445c-ae50-828017d82d9c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b0cb9a64-e80b-419d-9b92-0b66ec6720a9",
"_parent_code": "sample string 6",
"sales_organization_id": "8ee99a6c-e844-4ddd-a47b-94bbc2c04e77",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b5b0ea83-7948-4323-a910-b7afefc51540",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8d7921e-1586-4798-b362-00d6cf621980",
"db_currency_id": "f823f88d-8e98-4fad-9bfd-4dd133aecfc7",
"db_language_id": "51b58fd2-303d-4563-9764-a186454ce169",
"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-08-06T12:55:55.800819+00:00"
},
"modified_dateutc": "2026-08-06T12:55:55.800819+00:00"
},
"equipment_model_id": "7c86b92f-e5b4-4ceb-a834-6db89c104175",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "60d213d8-baa0-4783-86da-af9ce0137f1c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "574907dc-b549-4880-a497-b33dc92665c2",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "76192ddc-9c79-4110-9c6f-dee5fb30705a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7df43b1a-f21b-436d-9150-a4578aefd9d1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b5b0ea83-7948-4323-a910-b7afefc51540",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8d7921e-1586-4798-b362-00d6cf621980",
"db_currency_id": "f823f88d-8e98-4fad-9bfd-4dd133aecfc7",
"db_language_id": "51b58fd2-303d-4563-9764-a186454ce169",
"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-08-06T12:55:55.800819+00:00"
},
"modified_dateutc": "2026-08-06T12:55:55.800819+00:00"
},
"equipment_family_id": "2e769e8d-f8f6-4bb2-a368-6a7eb5b1c849",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "61517f5a-395a-445c-ae50-828017d82d9c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b0cb9a64-e80b-419d-9b92-0b66ec6720a9",
"_parent_code": "sample string 6",
"sales_organization_id": "8ee99a6c-e844-4ddd-a47b-94bbc2c04e77",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b5b0ea83-7948-4323-a910-b7afefc51540",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8d7921e-1586-4798-b362-00d6cf621980",
"db_currency_id": "f823f88d-8e98-4fad-9bfd-4dd133aecfc7",
"db_language_id": "51b58fd2-303d-4563-9764-a186454ce169",
"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-08-06T12:55:55.800819+00:00"
},
"modified_dateutc": "2026-08-06T12:55:55.800819+00:00"
},
"date_in_production_since": "2026-08-06T12:55:55.800819+00:00",
"date_out_of_production_since": "2026-08-06T12:55:55.800819+00:00",
"date_end_support": "2026-08-06T12:55:55.800819+00:00",
"sales_organization_id": "470c3e04-e1c3-4f68-98ae-831963544194",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b5b0ea83-7948-4323-a910-b7afefc51540",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8d7921e-1586-4798-b362-00d6cf621980",
"db_currency_id": "f823f88d-8e98-4fad-9bfd-4dd133aecfc7",
"db_language_id": "51b58fd2-303d-4563-9764-a186454ce169",
"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-08-06T12:55:55.800819+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-08-06T12:55:55.800819+00:00"
},
"project_status_id": "878a92d5-8227-48f1-9154-6cef7ace7f11",
"project_status_code": "sample string 10",
"project_status": {
"id": "21137cc1-4499-469f-9790-0579c571e602",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "de4412b6-06d8-4c29-a649-f5f798a494eb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b5b0ea83-7948-4323-a910-b7afefc51540",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8d7921e-1586-4798-b362-00d6cf621980",
"db_currency_id": "f823f88d-8e98-4fad-9bfd-4dd133aecfc7",
"db_language_id": "51b58fd2-303d-4563-9764-a186454ce169",
"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-08-06T12:55:55.800819+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-06T12:55:55.800819+00:00"
},
"company_id": "99ff590e-8637-41d7-981c-d3fe4a846ef7",
"company_code": "sample string 12",
"db_address_id": "5170dcb4-0554-4199-80d8-4d126f90a136",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5b0e96f7-0c13-4677-948f-7ef55de31b6f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3a4fa4c4-8b84-468d-9a42-c87e87fb2de6",
"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-08-06T12:55:55.800819+00:00",
"date_create": "2026-08-06T12:55:55.800819+00:00",
"date_update": "2026-08-06T12:55:55.800819+00:00",
"updated_by_user_id": "4e5242cd-2666-4454-9ae3-78eefcfce09b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-06T12:55:55.800819+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-08-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-06T12:55:55.800819+00:00",
"date_last_job": "2026-08-06T12:55:55.800819+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-06T12:55:55.800819+00:00",
"modified_dateutc": "2026-08-06T12:55:55.800819+00:00",
"is_mobile_installation": true
},
"job_type_id": "ac28973c-37e5-4c00-aaf5-19605fa29483",
"job_type_code": "sample string 7",
"job_type": {
"id": "93111e3c-e4f4-4da8-992c-d3cd5ef58f01",
"name": "sample string 2",
"sales_organization_id": "8f4ae221-1133-4efc-8ca0-7e19cedc2bcd",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-06T12:55:55.800819+00:00",
"code": "sample string 7"
},
"job_priority_id": "edd45cb0-82f3-4411-b12e-38045f39081e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a06d4bf6-b134-40a9-bcf2-f8ca715abe9c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0bc6a3da-38d9-4098-a98a-8418c2d02043",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b5b0ea83-7948-4323-a910-b7afefc51540",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8d7921e-1586-4798-b362-00d6cf621980",
"db_currency_id": "f823f88d-8e98-4fad-9bfd-4dd133aecfc7",
"db_language_id": "51b58fd2-303d-4563-9764-a186454ce169",
"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-08-06T12:55:55.800819+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-06T12:55:55.800819+00:00"
},
"job_status_id": "1ec0aea0-2837-45b3-b829-1577b830d5eb",
"job_status_code": "sample string 11",
"db_address_id": "14a90be9-a095-4778-b873-1b34bc31caae",
"contact_id": "42d7d37d-284d-4f85-9522-530a6cf5accb",
"requested_by_company_id": "055d0a02-2ecf-4b86-a15a-02df11315785",
"requested_by_contact_id": "e7006340-d8e2-4baa-a2cc-9b05824f6cc8",
"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-08-06T12:55:55.800819+00:00",
"due_date": "2026-08-06T12:55:55.800819+00:00",
"date_create": "2026-08-06T12:55:55.800819+00:00",
"date_update": "2026-08-06T12:55:55.800819+00:00",
"date_closed": "2026-08-06T12:55:55.800819+00:00",
"suggested_user_id": "eef57002-740c-4663-9150-b2ec6ae7f063",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "cdd5b6f3-abd6-440a-be6b-c8df074d49e1",
"db_language_id": "7963bc68-5c09-456b-b4f4-87d41945f1b9",
"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-08-06T12:55:55.800819+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d011d849-d840-4c05-9a01-e8bd22be16cb",
"sales_organization": {
"id": "b5b0ea83-7948-4323-a910-b7afefc51540",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8d7921e-1586-4798-b362-00d6cf621980",
"db_currency_id": "f823f88d-8e98-4fad-9bfd-4dd133aecfc7",
"db_language_id": "51b58fd2-303d-4563-9764-a186454ce169",
"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-08-06T12:55:55.800819+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e129a23f-5ad6-4cd8-a7a4-499c36eec358",
"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": "063aacd6-3b8a-43b2-99aa-d47766bee7f4",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-06T12:55:55.800819+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ee1e19b7-0c98-4d4e-946a-9f902b78db07"
},
"suggested_date_start": "2026-08-06T12:55:55.800819+00:00",
"skill_id": "246fe49e-be18-4b03-a8cc-a7ab12c7bc76",
"skill_code": "sample string 32",
"skill": {
"id": "6123d347-58b2-4870-9509-e3ba82c377a4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f857d2f8-3792-4776-af67-5d769858cc02",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b5b0ea83-7948-4323-a910-b7afefc51540",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8d7921e-1586-4798-b362-00d6cf621980",
"db_currency_id": "f823f88d-8e98-4fad-9bfd-4dd133aecfc7",
"db_language_id": "51b58fd2-303d-4563-9764-a186454ce169",
"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-08-06T12:55:55.800819+00:00"
},
"modified_dateutc": "2026-08-06T12:55:55.800819+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "eb0fc43c-892b-40c6-ac62-7e4426bc02ca",
"date_reported_by_company": "2026-08-06T12:55:55.800819+00:00",
"id2": 36,
"company_id": "84700dcd-72ac-4b2e-b245-d5d7cd5a466a",
"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": "6a0f982a-94cd-4c8d-952a-96ff403a1a1f",
"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-08-06T12:55:55.800819+00:00"
},
"work_instruction_details_id": "11aa4058-7d1a-4b51-a18f-d0cbc67e5ddd",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "cd13566d-53bf-43d9-bc16-d8cbb2f1a0f4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "188d9798-8417-4b6f-a726-012f91d7cae9",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-06T12:55:55.800819+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": "44e04271-5410-45fe-8a44-da8c0d653f25",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-06T12:55:55.800819+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.