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": "bd54b86a-83ab-4ec4-9d81-1ecfedb94450",
"jobs_id": "1206f45f-1432-4470-91bd-20d5e9aa9557",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d96eeb9f-3e08-4a6c-8091-b9b202433823",
"_parent_id": "637c5051-b637-456d-95fa-53f5a205202a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "99171f17-672c-4a97-92d9-c6a9b333a1ed",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f2cf71e6-f292-45fe-9a1f-4dad78bef364",
"_parent_id": "dad440db-840f-41d4-a901-66465b857717",
"root_parent_id": "9c7ebe55-23b6-40e9-baa1-9bbc7031ef79",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "25fb9896-6ec1-454a-9a1e-a19710a472a1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f19a4294-7b10-4c5b-91b9-5ea7816dff91",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d76014ed-990a-4dd3-bbed-e453f9679d6d",
"_parent_code": "sample string 6",
"sales_organization_id": "0cc11da1-391f-4d5d-85e5-6c444c212358",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5c827d85-3848-4861-93b0-369c05416efc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e81016ea-1740-4a8f-afa0-aed4793ffab3",
"db_currency_id": "06480f16-821e-49cd-9eed-0b50192bea70",
"db_language_id": "7003a792-0de3-4a1e-9617-ddf85d07d8e3",
"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-15T18:58:26.7923525+00:00"
},
"modified_dateutc": "2026-05-15T18:58:26.7923525+00:00"
},
"equipment_model_id": "ae34c4d2-644b-48a9-b9aa-90940b366cde",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fc310039-4dcb-4911-b6ed-d691494ff7f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f1489f5d-5727-4c58-9457-adc528fd9f97",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5419e890-93a3-42a8-a5b4-f0cd286eef96",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "be2585d6-0f4d-442d-93f3-eb4963751961",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5c827d85-3848-4861-93b0-369c05416efc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e81016ea-1740-4a8f-afa0-aed4793ffab3",
"db_currency_id": "06480f16-821e-49cd-9eed-0b50192bea70",
"db_language_id": "7003a792-0de3-4a1e-9617-ddf85d07d8e3",
"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-15T18:58:26.7923525+00:00"
},
"modified_dateutc": "2026-05-15T18:58:26.7923525+00:00"
},
"equipment_family_id": "ef69a906-c5e7-49bd-8d8f-7079f809e231",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f19a4294-7b10-4c5b-91b9-5ea7816dff91",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d76014ed-990a-4dd3-bbed-e453f9679d6d",
"_parent_code": "sample string 6",
"sales_organization_id": "0cc11da1-391f-4d5d-85e5-6c444c212358",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5c827d85-3848-4861-93b0-369c05416efc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e81016ea-1740-4a8f-afa0-aed4793ffab3",
"db_currency_id": "06480f16-821e-49cd-9eed-0b50192bea70",
"db_language_id": "7003a792-0de3-4a1e-9617-ddf85d07d8e3",
"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-15T18:58:26.7923525+00:00"
},
"modified_dateutc": "2026-05-15T18:58:26.7923525+00:00"
},
"date_in_production_since": "2026-05-15T18:58:26.7923525+00:00",
"date_out_of_production_since": "2026-05-15T18:58:26.7923525+00:00",
"date_end_support": "2026-05-15T18:58:26.7923525+00:00",
"sales_organization_id": "85513d5f-82bc-46a0-b5b9-0f9596216184",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5c827d85-3848-4861-93b0-369c05416efc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e81016ea-1740-4a8f-afa0-aed4793ffab3",
"db_currency_id": "06480f16-821e-49cd-9eed-0b50192bea70",
"db_language_id": "7003a792-0de3-4a1e-9617-ddf85d07d8e3",
"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-15T18:58:26.7923525+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-15T18:58:26.7923525+00:00"
},
"project_status_id": "8960e79f-c8b8-4b16-8b79-337ccbc72c26",
"project_status_code": "sample string 10",
"project_status": {
"id": "961bbb5c-78b9-486b-9aba-c24285e816af",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "02c5ff64-2e34-4777-9e81-f7cb6968612a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5c827d85-3848-4861-93b0-369c05416efc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e81016ea-1740-4a8f-afa0-aed4793ffab3",
"db_currency_id": "06480f16-821e-49cd-9eed-0b50192bea70",
"db_language_id": "7003a792-0de3-4a1e-9617-ddf85d07d8e3",
"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-15T18:58:26.7923525+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-15T18:58:26.7923525+00:00"
},
"company_id": "d351089f-1c20-4741-9f22-0bafb6f9d029",
"company_code": "sample string 12",
"db_address_id": "a60443e6-2f6e-4029-89b8-de41e19f0403",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9c1ed04e-962c-473a-989a-e1217b8f5680",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b54d0e8d-b964-4620-86bc-bf76fa2c044c",
"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-15T18:58:26.7923525+00:00",
"date_create": "2026-05-15T18:58:26.7923525+00:00",
"date_update": "2026-05-15T18:58:26.7923525+00:00",
"updated_by_user_id": "2b3a345e-d3a5-4b77-a7cf-25150374f2ce",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-15T18:58:26.7923525+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-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-15T18:58:26.7923525+00:00",
"date_last_job": "2026-05-15T18:58:26.7923525+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-15T18:58:26.7923525+00:00",
"modified_dateutc": "2026-05-15T18:58:26.7923525+00:00",
"is_mobile_installation": true
},
"job_type_id": "4cd50252-b0e0-4f71-97b4-a4d76f1ea7cf",
"job_type_code": "sample string 7",
"job_type": {
"id": "3519979d-68db-4c5f-b61e-88ededae7f75",
"name": "sample string 2",
"sales_organization_id": "cfe3673d-e13b-4571-b8a4-a174a1c730e8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-15T18:58:26.7923525+00:00",
"code": "sample string 7"
},
"job_priority_id": "e8fa4fc6-3e6d-4ddc-be79-bc0619d8e013",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "577083af-6b2a-49dd-9397-42c059c2b896",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3c2b7816-fe40-4511-9b10-67652edcc780",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5c827d85-3848-4861-93b0-369c05416efc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e81016ea-1740-4a8f-afa0-aed4793ffab3",
"db_currency_id": "06480f16-821e-49cd-9eed-0b50192bea70",
"db_language_id": "7003a792-0de3-4a1e-9617-ddf85d07d8e3",
"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-15T18:58:26.7923525+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-15T18:58:26.7923525+00:00"
},
"job_status_id": "fe73301d-ae27-4e56-beb0-90d21fc5e5d5",
"job_status_code": "sample string 11",
"db_address_id": "24005d81-03fa-4c34-a632-11724b399d4b",
"contact_id": "296706fa-7cca-4d66-94ed-4d54ed6871dd",
"requested_by_company_id": "381eb5d8-6472-48b2-b70d-fcb4df24ac80",
"requested_by_contact_id": "788b2c2c-ae53-466d-ac39-38f8bb2a1f20",
"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-15T18:58:26.7923525+00:00",
"due_date": "2026-05-15T18:58:26.7923525+00:00",
"date_create": "2026-05-15T18:58:26.7923525+00:00",
"date_update": "2026-05-15T18:58:26.7923525+00:00",
"date_closed": "2026-05-15T18:58:26.7923525+00:00",
"suggested_user_id": "04d0bf02-c996-4f49-a105-bbf1d9447fe9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4f26268d-2f63-427a-8a08-f868396ac7b3",
"db_language_id": "a7fc5c10-feb8-4980-9474-d6699edbc1e4",
"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-15T18:58:26.7923525+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "91fd41e5-86b6-43ce-bb63-cca4ffb9081c",
"sales_organization": {
"id": "5c827d85-3848-4861-93b0-369c05416efc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e81016ea-1740-4a8f-afa0-aed4793ffab3",
"db_currency_id": "06480f16-821e-49cd-9eed-0b50192bea70",
"db_language_id": "7003a792-0de3-4a1e-9617-ddf85d07d8e3",
"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-15T18:58:26.7923525+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4c232647-77ac-4ecd-b90a-cdf0e673bc0a",
"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": "0ba7551a-2c7a-4ccc-9d07-5b3c873ff176",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-15T18:58:26.7923525+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ed3d9a02-df02-41a6-acce-d60d9c81b048"
},
"suggested_date_start": "2026-05-15T18:58:26.7923525+00:00",
"skill_id": "2fd23943-ad24-4063-bda6-b4ab4d092987",
"skill_code": "sample string 32",
"skill": {
"id": "107c8808-455d-4277-817a-730007f312e1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3814a72c-7115-4ceb-94aa-700e081e2538",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5c827d85-3848-4861-93b0-369c05416efc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e81016ea-1740-4a8f-afa0-aed4793ffab3",
"db_currency_id": "06480f16-821e-49cd-9eed-0b50192bea70",
"db_language_id": "7003a792-0de3-4a1e-9617-ddf85d07d8e3",
"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-15T18:58:26.7923525+00:00"
},
"modified_dateutc": "2026-05-15T18:58:26.7923525+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "49cc4e49-21ae-4a26-a5bc-783cd61bac71",
"date_reported_by_company": "2026-05-15T18:58:26.7923525+00:00",
"id2": 36,
"company_id": "aa668737-8098-4509-b563-e5321b91f8c7",
"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": "f7fece2b-32fa-43d0-be55-64c778a399a9",
"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-15T18:58:26.7923525+00:00"
},
"work_instruction_details_id": "b13d2991-0a80-41c9-95a2-2f9d2b8c1170",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "aa2effb2-758f-4378-aafa-6c9fdfdbfbcc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "94ee9481-2451-491a-9579-b15d8fac53b9",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-15T18:58:26.7923525+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": "4585e435-5db8-4c6e-aea1-66989ea84e67",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-15T18:58:26.7923525+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.