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": "e530f8c3-bbbe-4f87-8b0e-adb67b8f40e1",
"jobs_id": "468ddea0-9e45-440f-b7ca-de972b522119",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f1609d6e-daa6-4b06-bb2b-797a0ea73da2",
"_parent_id": "4c2a45c9-2bfd-4e94-a78b-e586e94938b8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ca74da4e-13d3-4c1a-89ee-0ece05ea9fd6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "051f5131-92f5-45ea-8ac6-bae9f77e378f",
"_parent_id": "6baaefb0-4863-4c2c-8e05-b986ff3824ef",
"root_parent_id": "bad9c09d-a4dc-4f26-9934-b0bedd169bd3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5451fbf7-6e6c-40c7-bd95-62017b6b4b59",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d9848976-e949-4860-88f1-868028674448",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4fa26a78-ebbf-4986-8bdb-d3664dcc14fa",
"_parent_code": "sample string 6",
"sales_organization_id": "4e575d5b-c4be-437f-ab86-e1832c92269e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9c81d4cd-1d4b-4369-a3d5-4dda0afc9c39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70ca2297-60af-47b5-acf0-21fe663b27ad",
"db_currency_id": "0c0bd2c2-4ccc-4722-871e-2b6330c16077",
"db_language_id": "a62ffc7e-c25c-4b63-a1a2-d7afa764fcd4",
"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-04T03:44:36.0319106+00:00"
},
"modified_dateutc": "2026-09-04T03:44:36.0319106+00:00"
},
"equipment_model_id": "d92b4295-3873-4e15-b9d2-fd39a3280648",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1d674a06-7ef4-4054-9435-f12558ece6b8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8654804e-fdc7-4aad-b0cd-eb1e8b7904fd",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6dc19dd7-bfd4-4e7a-8c15-95e433fd0ca9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f7fd0b3c-6cc1-4d8f-983b-318376aec7bb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9c81d4cd-1d4b-4369-a3d5-4dda0afc9c39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70ca2297-60af-47b5-acf0-21fe663b27ad",
"db_currency_id": "0c0bd2c2-4ccc-4722-871e-2b6330c16077",
"db_language_id": "a62ffc7e-c25c-4b63-a1a2-d7afa764fcd4",
"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-04T03:44:36.0319106+00:00"
},
"modified_dateutc": "2026-09-04T03:44:36.0319106+00:00"
},
"equipment_family_id": "d99090ef-64b9-46e5-be9c-cae88123692a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d9848976-e949-4860-88f1-868028674448",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4fa26a78-ebbf-4986-8bdb-d3664dcc14fa",
"_parent_code": "sample string 6",
"sales_organization_id": "4e575d5b-c4be-437f-ab86-e1832c92269e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9c81d4cd-1d4b-4369-a3d5-4dda0afc9c39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70ca2297-60af-47b5-acf0-21fe663b27ad",
"db_currency_id": "0c0bd2c2-4ccc-4722-871e-2b6330c16077",
"db_language_id": "a62ffc7e-c25c-4b63-a1a2-d7afa764fcd4",
"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-04T03:44:36.0319106+00:00"
},
"modified_dateutc": "2026-09-04T03:44:36.0319106+00:00"
},
"date_in_production_since": "2026-09-04T03:44:36.0319106+00:00",
"date_out_of_production_since": "2026-09-04T03:44:36.0319106+00:00",
"date_end_support": "2026-09-04T03:44:36.0319106+00:00",
"sales_organization_id": "42b42a35-93cc-43b6-8f64-15c536c2f0e7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9c81d4cd-1d4b-4369-a3d5-4dda0afc9c39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70ca2297-60af-47b5-acf0-21fe663b27ad",
"db_currency_id": "0c0bd2c2-4ccc-4722-871e-2b6330c16077",
"db_language_id": "a62ffc7e-c25c-4b63-a1a2-d7afa764fcd4",
"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-04T03:44:36.0319106+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-04T03:44:36.0319106+00:00"
},
"project_status_id": "26faf042-5658-4d13-9768-bd8b9a7e6ad7",
"project_status_code": "sample string 10",
"project_status": {
"id": "c57cc8ba-1aa4-434f-a572-a8e660344be8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1fba5a2f-c22f-46c4-8a03-1783cb6ae10b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9c81d4cd-1d4b-4369-a3d5-4dda0afc9c39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70ca2297-60af-47b5-acf0-21fe663b27ad",
"db_currency_id": "0c0bd2c2-4ccc-4722-871e-2b6330c16077",
"db_language_id": "a62ffc7e-c25c-4b63-a1a2-d7afa764fcd4",
"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-04T03:44:36.0319106+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-04T03:44:36.0319106+00:00"
},
"company_id": "ad9f296a-d820-41e8-bddb-7c2feb8b5909",
"company_code": "sample string 12",
"db_address_id": "4c5d8534-bfa6-4184-9570-0fe34b5b72e3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "afa8af49-c9ad-4db3-840b-d024d9f275b4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "28600ff0-d039-4891-84e7-b16ff4f6933e",
"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-04T03:44:36.0319106+00:00",
"date_create": "2026-09-04T03:44:36.0319106+00:00",
"date_update": "2026-09-04T03:44:36.0319106+00:00",
"updated_by_user_id": "03120ce8-1581-4de3-8598-2676b14ab4f1",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-04T03:44:36.0319106+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-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-04T03:44:36.0319106+00:00",
"date_last_job": "2026-09-04T03:44:36.0319106+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-04T03:44:36.0319106+00:00",
"modified_dateutc": "2026-09-04T03:44:36.0319106+00:00",
"is_mobile_installation": true
},
"job_type_id": "9bc7739b-86f0-4c11-8db5-7017cef0f58a",
"job_type_code": "sample string 7",
"job_type": {
"id": "67da3c90-e103-45d1-9e7f-c8c7706d8e9b",
"name": "sample string 2",
"sales_organization_id": "f25f1db8-97da-48c5-8150-33c7e522a050",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-04T03:44:36.0319106+00:00",
"code": "sample string 7"
},
"job_priority_id": "3e39d5df-e928-41f6-9a87-8622a1cfefe8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e2014f0d-3028-4ba7-be6f-18ef872ab8f1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7a222caf-3fe4-45bb-80a2-6455f4e3eb2f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9c81d4cd-1d4b-4369-a3d5-4dda0afc9c39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70ca2297-60af-47b5-acf0-21fe663b27ad",
"db_currency_id": "0c0bd2c2-4ccc-4722-871e-2b6330c16077",
"db_language_id": "a62ffc7e-c25c-4b63-a1a2-d7afa764fcd4",
"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-04T03:44:36.0319106+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-04T03:44:36.0319106+00:00"
},
"job_status_id": "64e23aec-aca6-4432-bb5b-d0e34abe40b4",
"job_status_code": "sample string 11",
"db_address_id": "c9d6d517-df8e-4543-859e-34381d57bc9a",
"contact_id": "65ea141a-28e8-4a16-af3f-3e2777fd8a98",
"requested_by_company_id": "b923a434-9091-40e8-b1ab-e867b65bacaa",
"requested_by_contact_id": "1bcb0c4c-3a26-4139-b8d2-05ed989760f9",
"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-04T03:44:36.0319106+00:00",
"due_date": "2026-09-04T03:44:36.0319106+00:00",
"date_create": "2026-09-04T03:44:36.0319106+00:00",
"date_update": "2026-09-04T03:44:36.0319106+00:00",
"date_closed": "2026-09-04T03:44:36.0319106+00:00",
"suggested_user_id": "900ae494-34fc-49a1-bcfd-062c4b4f7d38",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "62964a9f-1396-4b7e-81bb-d3c704b3b774",
"db_language_id": "9133ec06-0223-4a2c-b168-a53b70cdce57",
"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-04T03:44:36.0319106+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "28179fb8-6fb1-4c75-95d9-cce636705366",
"sales_organization": {
"id": "9c81d4cd-1d4b-4369-a3d5-4dda0afc9c39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70ca2297-60af-47b5-acf0-21fe663b27ad",
"db_currency_id": "0c0bd2c2-4ccc-4722-871e-2b6330c16077",
"db_language_id": "a62ffc7e-c25c-4b63-a1a2-d7afa764fcd4",
"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-04T03:44:36.0319106+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7c968a4a-3493-4dfc-9572-40288f370fca",
"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": "29b4be87-4ba3-45c2-9b59-9d4d3304fbd9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-04T03:44:36.0319106+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "30a7e319-2a05-4606-85f5-f11274fc9cf9"
},
"suggested_date_start": "2026-09-04T03:44:36.0319106+00:00",
"skill_id": "b2055a36-5e5c-4023-b7f6-fbc733061958",
"skill_code": "sample string 32",
"skill": {
"id": "dbc38e36-bab7-4370-a6ad-ee1733e29030",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "76f13db5-3ef4-49e0-b223-e8c2b3f9f571",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9c81d4cd-1d4b-4369-a3d5-4dda0afc9c39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70ca2297-60af-47b5-acf0-21fe663b27ad",
"db_currency_id": "0c0bd2c2-4ccc-4722-871e-2b6330c16077",
"db_language_id": "a62ffc7e-c25c-4b63-a1a2-d7afa764fcd4",
"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-04T03:44:36.0319106+00:00"
},
"modified_dateutc": "2026-09-04T03:44:36.0319106+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c119846d-20ac-46bf-ad59-de9aeff72186",
"date_reported_by_company": "2026-09-04T03:44:36.0319106+00:00",
"id2": 36,
"company_id": "0d05cf5f-3b2c-47c8-9cab-78b8c84f5210",
"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": "8f02ed37-3c2f-42c4-9956-6060bb9ddcb0",
"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-04T03:44:36.0319106+00:00"
},
"work_instruction_details_id": "381f7695-624a-49ad-81f6-7e2b23016239",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6ee9d75c-9b3c-4404-ade5-e70071dd575c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ac19888c-2e70-4426-9fb1-4d2f63a0cccd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-04T03:44:36.0319106+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": "63ce2fc2-ce77-4916-a5ce-c5ab81506517",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-04T03:44:36.0319106+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.