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": "0a12dc51-01fb-429d-b656-344636c81181",
"jobs_id": "c0c43459-eff2-4180-a668-b0a15aa2db7b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a14bcd4f-2437-4c38-8e55-1ab59b3b7bc0",
"_parent_id": "9d71a3b4-faed-44f0-a333-9878b1dfd1f9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3ffcecf7-7b70-47cd-b650-0c2158bf654e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "85b7f2e2-bf20-4d87-a8db-36ec53076cb4",
"_parent_id": "ac166e1e-353b-4777-9e0d-03846d9ff289",
"root_parent_id": "e0d06ccc-4b08-4e93-908f-35b901fc6e17",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ef1c81c3-4591-4e7b-a73c-7d84581fc4d2",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "17ef018c-523c-435b-bd78-8f9835db13a7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "05ef5138-bac9-4ae5-baa8-4b4190e14eda",
"_parent_code": "sample string 6",
"sales_organization_id": "97786721-aefd-4e2a-af36-ad73b9715485",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "20b13434-8b87-4f79-9ae6-d0042447c9e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbc6e4d9-99e4-48ac-bbcc-1a6ef814d216",
"db_currency_id": "1cf841f9-c43e-4040-a544-4a4aa20684ff",
"db_language_id": "f7c0734b-8fd9-48c2-b50b-2ca4bd60d073",
"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-06-30T05:55:53.7588262+00:00"
},
"modified_dateutc": "2026-06-30T05:55:53.7588262+00:00"
},
"equipment_model_id": "9794942d-00ac-47b2-b3c7-ae37d48ce989",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2701d86f-baa8-4c80-b055-f660784277c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "56eeae91-d31c-4916-a3f1-66204781ce96",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ad36768e-ef96-4320-8a8a-d904c878ef20",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "164dafc6-3d35-41e5-aa98-bd8441dc2378",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "20b13434-8b87-4f79-9ae6-d0042447c9e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbc6e4d9-99e4-48ac-bbcc-1a6ef814d216",
"db_currency_id": "1cf841f9-c43e-4040-a544-4a4aa20684ff",
"db_language_id": "f7c0734b-8fd9-48c2-b50b-2ca4bd60d073",
"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-06-30T05:55:53.7588262+00:00"
},
"modified_dateutc": "2026-06-30T05:55:53.7588262+00:00"
},
"equipment_family_id": "d6a85a0a-9cf1-4064-9997-68740bc267c0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "17ef018c-523c-435b-bd78-8f9835db13a7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "05ef5138-bac9-4ae5-baa8-4b4190e14eda",
"_parent_code": "sample string 6",
"sales_organization_id": "97786721-aefd-4e2a-af36-ad73b9715485",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "20b13434-8b87-4f79-9ae6-d0042447c9e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbc6e4d9-99e4-48ac-bbcc-1a6ef814d216",
"db_currency_id": "1cf841f9-c43e-4040-a544-4a4aa20684ff",
"db_language_id": "f7c0734b-8fd9-48c2-b50b-2ca4bd60d073",
"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-06-30T05:55:53.7588262+00:00"
},
"modified_dateutc": "2026-06-30T05:55:53.7588262+00:00"
},
"date_in_production_since": "2026-06-30T05:55:53.7588262+00:00",
"date_out_of_production_since": "2026-06-30T05:55:53.7588262+00:00",
"date_end_support": "2026-06-30T05:55:53.7588262+00:00",
"sales_organization_id": "19fef022-f8f0-4049-a66d-0da5d67c1984",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "20b13434-8b87-4f79-9ae6-d0042447c9e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbc6e4d9-99e4-48ac-bbcc-1a6ef814d216",
"db_currency_id": "1cf841f9-c43e-4040-a544-4a4aa20684ff",
"db_language_id": "f7c0734b-8fd9-48c2-b50b-2ca4bd60d073",
"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-06-30T05:55:53.7588262+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-06-30T05:55:53.7588262+00:00"
},
"project_status_id": "7bd3c3ec-6320-4b7a-8658-2154ddf93b77",
"project_status_code": "sample string 10",
"project_status": {
"id": "009ee7d4-92c1-4668-a4bd-b0256a96290b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "cbae8112-db90-4af1-969a-fdad2836d72d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "20b13434-8b87-4f79-9ae6-d0042447c9e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbc6e4d9-99e4-48ac-bbcc-1a6ef814d216",
"db_currency_id": "1cf841f9-c43e-4040-a544-4a4aa20684ff",
"db_language_id": "f7c0734b-8fd9-48c2-b50b-2ca4bd60d073",
"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-06-30T05:55:53.7588262+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-30T05:55:53.7588262+00:00"
},
"company_id": "f8f3fcad-111e-4fac-8b88-8edbf531aece",
"company_code": "sample string 12",
"db_address_id": "1b1ececf-cf38-42b9-be09-10641e60e536",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "06880075-013f-4856-a8a3-b6d41cfaa294",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a675956f-9522-4eda-a41f-c438672fc462",
"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-06-30T05:55:53.7588262+00:00",
"date_create": "2026-06-30T05:55:53.7588262+00:00",
"date_update": "2026-06-30T05:55:53.7588262+00:00",
"updated_by_user_id": "ef2e857e-2f52-4670-93d9-165805d6a1d0",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-30T05:55:53.7588262+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-06-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-30T05:55:53.7744523+00:00",
"date_last_job": "2026-06-30T05:55:53.7744523+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-30T05:55:53.7744523+00:00",
"modified_dateutc": "2026-06-30T05:55:53.7744523+00:00",
"is_mobile_installation": true
},
"job_type_id": "811ab412-3e0c-480b-993b-dcc1f7dd22a7",
"job_type_code": "sample string 7",
"job_type": {
"id": "2d5e35d2-f063-4e28-9a30-890e71aa5aaf",
"name": "sample string 2",
"sales_organization_id": "7686c769-215f-4bfe-a351-cfdd1d1f48dd",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-30T05:55:53.7744523+00:00",
"code": "sample string 7"
},
"job_priority_id": "ba95dd98-c4e8-482b-a9cc-ad4d7f106a6e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6f0d537a-f665-493d-99c2-626fa006ae33",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3e1f1e3b-9b52-4c66-a621-64a7c4a04f3e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "20b13434-8b87-4f79-9ae6-d0042447c9e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbc6e4d9-99e4-48ac-bbcc-1a6ef814d216",
"db_currency_id": "1cf841f9-c43e-4040-a544-4a4aa20684ff",
"db_language_id": "f7c0734b-8fd9-48c2-b50b-2ca4bd60d073",
"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-06-30T05:55:53.7588262+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-30T05:55:53.7744523+00:00"
},
"job_status_id": "66bf7dbd-326e-4f92-88db-82e73437ff85",
"job_status_code": "sample string 11",
"db_address_id": "3ac4077c-23ba-4d44-bf12-1b70145ce1c9",
"contact_id": "0cf171bc-459c-4e04-9de4-3bec6c1aef3c",
"requested_by_company_id": "fe313b2d-30d6-45d0-97ad-c207941ed219",
"requested_by_contact_id": "79050792-e0d1-4a42-8ce1-efe267059e5f",
"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-06-30T05:55:53.7744523+00:00",
"due_date": "2026-06-30T05:55:53.7744523+00:00",
"date_create": "2026-06-30T05:55:53.7744523+00:00",
"date_update": "2026-06-30T05:55:53.7744523+00:00",
"date_closed": "2026-06-30T05:55:53.7744523+00:00",
"suggested_user_id": "697f856b-ef95-43df-bc42-da833cca328d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "10ff9961-86d3-4729-ac4b-3a47c94fdc80",
"db_language_id": "6f283b94-658b-44b6-8bd5-89b455b213be",
"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-06-30T05:55:53.7744523+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "12401137-26c5-40d1-ad37-a3389f033749",
"sales_organization": {
"id": "20b13434-8b87-4f79-9ae6-d0042447c9e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbc6e4d9-99e4-48ac-bbcc-1a6ef814d216",
"db_currency_id": "1cf841f9-c43e-4040-a544-4a4aa20684ff",
"db_language_id": "f7c0734b-8fd9-48c2-b50b-2ca4bd60d073",
"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-06-30T05:55:53.7588262+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e322e5f2-1ada-4f7f-95c5-8eb0eb5eff3e",
"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": "2f48d3e7-6643-42d8-bd8f-0623b4a0eace",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-30T05:55:53.7744523+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f3de6d40-a377-4282-a2ff-63d6b8cb6368"
},
"suggested_date_start": "2026-06-30T05:55:53.7744523+00:00",
"skill_id": "0e7d6e9d-e2d0-4c65-93e5-02a0fd6c16bb",
"skill_code": "sample string 32",
"skill": {
"id": "51c37d76-9de0-4fe4-899d-28dbdfe6f47b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "89815546-c818-4ad2-9d95-e20ec98a7829",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "20b13434-8b87-4f79-9ae6-d0042447c9e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbc6e4d9-99e4-48ac-bbcc-1a6ef814d216",
"db_currency_id": "1cf841f9-c43e-4040-a544-4a4aa20684ff",
"db_language_id": "f7c0734b-8fd9-48c2-b50b-2ca4bd60d073",
"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-06-30T05:55:53.7588262+00:00"
},
"modified_dateutc": "2026-06-30T05:55:53.7744523+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "76d5d1c5-0f29-4c91-a7d0-6fa0655efd0d",
"date_reported_by_company": "2026-06-30T05:55:53.7744523+00:00",
"id2": 36,
"company_id": "9cfcad88-2e77-45cc-9147-1cf890dd5d8c",
"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": "0a30aa63-9f2e-4b14-a1e3-69cbb535c389",
"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-06-30T05:55:53.7744523+00:00"
},
"work_instruction_details_id": "0e510e31-dd8d-4e7e-99b2-5a3a149fdb77",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1cfa3c2e-b305-4dd3-9aad-60b71b66ad4b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "400eea83-8bd3-44ba-8b82-599fa571433c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-30T05:55:53.7744523+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": "c2dbcef4-c84e-4a8d-b672-be34a8b48d0e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-30T05:55:53.7744523+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.