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": "c1320719-dc50-45bc-990e-a67748afe8ce",
"jobs_id": "0ad0ea41-6676-4623-a7b6-4d89d449509d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "744faeca-0ee5-4851-9f12-6cc1fb5ef647",
"_parent_id": "9c7faf35-1aa2-40b8-b48a-753eebba9e2c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b2c5a348-060b-4dbc-993c-8f7917463ea2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d8b46106-75a8-45d4-a5f9-3f925e831b61",
"_parent_id": "b69c6d07-ebc7-4f6a-90f0-ff301b104242",
"root_parent_id": "64af8592-932f-48c2-948d-a20316cad210",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "349d24a8-d5c5-4cca-ae89-ab75a6fd6605",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "987ea217-8633-40c9-bef3-1382259efc45",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "52f20941-9a7f-4b2b-b84f-1f4249bc68ed",
"_parent_code": "sample string 6",
"sales_organization_id": "d00ac8bc-9211-4d32-b102-7f2f99d6a32e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "da2dd970-d465-4536-b30b-61b8921c27a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9155a071-a125-4bef-950b-f007bceb93e1",
"db_currency_id": "de7342a5-49c3-492a-98af-d3d77b9b15d4",
"db_language_id": "5f213312-85a2-4e86-8680-54b07eee176a",
"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-29T04:03:02.9437399+00:00"
},
"modified_dateutc": "2026-08-29T04:03:02.9437399+00:00"
},
"equipment_model_id": "5c727493-f612-43bb-9efa-5afeb174cf3c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "add9dab0-4018-4bb9-9945-00c3394b4f4a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "51839800-3681-452f-95b2-488666b370f4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ca6dbc6f-9059-46f3-955a-988ae56d4b8d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b0d50ae4-f6fc-4837-aa9f-094004d6d93b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "da2dd970-d465-4536-b30b-61b8921c27a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9155a071-a125-4bef-950b-f007bceb93e1",
"db_currency_id": "de7342a5-49c3-492a-98af-d3d77b9b15d4",
"db_language_id": "5f213312-85a2-4e86-8680-54b07eee176a",
"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-29T04:03:02.9437399+00:00"
},
"modified_dateutc": "2026-08-29T04:03:02.9437399+00:00"
},
"equipment_family_id": "6785b29c-a9a9-45a0-b872-5db5110e1bbf",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "987ea217-8633-40c9-bef3-1382259efc45",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "52f20941-9a7f-4b2b-b84f-1f4249bc68ed",
"_parent_code": "sample string 6",
"sales_organization_id": "d00ac8bc-9211-4d32-b102-7f2f99d6a32e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "da2dd970-d465-4536-b30b-61b8921c27a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9155a071-a125-4bef-950b-f007bceb93e1",
"db_currency_id": "de7342a5-49c3-492a-98af-d3d77b9b15d4",
"db_language_id": "5f213312-85a2-4e86-8680-54b07eee176a",
"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-29T04:03:02.9437399+00:00"
},
"modified_dateutc": "2026-08-29T04:03:02.9437399+00:00"
},
"date_in_production_since": "2026-08-29T04:03:02.9437399+00:00",
"date_out_of_production_since": "2026-08-29T04:03:02.9437399+00:00",
"date_end_support": "2026-08-29T04:03:02.9437399+00:00",
"sales_organization_id": "2504580e-cdac-4f2f-b584-3010f9b5c9c3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "da2dd970-d465-4536-b30b-61b8921c27a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9155a071-a125-4bef-950b-f007bceb93e1",
"db_currency_id": "de7342a5-49c3-492a-98af-d3d77b9b15d4",
"db_language_id": "5f213312-85a2-4e86-8680-54b07eee176a",
"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-29T04:03:02.9437399+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-29T04:03:02.9437399+00:00"
},
"project_status_id": "78dc9379-fe3f-4fef-8c6e-053f800e9150",
"project_status_code": "sample string 10",
"project_status": {
"id": "b18a64f4-2413-4670-9028-a84d6c352820",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "926939a8-ff8c-472f-b157-36e73f4a11cd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "da2dd970-d465-4536-b30b-61b8921c27a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9155a071-a125-4bef-950b-f007bceb93e1",
"db_currency_id": "de7342a5-49c3-492a-98af-d3d77b9b15d4",
"db_language_id": "5f213312-85a2-4e86-8680-54b07eee176a",
"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-29T04:03:02.9437399+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-29T04:03:02.9437399+00:00"
},
"company_id": "766bc83e-1867-4498-b23e-75918add96cd",
"company_code": "sample string 12",
"db_address_id": "22d63151-3359-4462-b205-60dc4301efc9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4c16c9b1-3a32-4274-a8ca-361b5a798666",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3965b218-067a-4dd6-a06c-02040bcebe05",
"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-29T04:03:02.9437399+00:00",
"date_create": "2026-08-29T04:03:02.9437399+00:00",
"date_update": "2026-08-29T04:03:02.9437399+00:00",
"updated_by_user_id": "502c3cc1-a2b8-42b6-ac09-24ef608e5fe0",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-29T04:03:02.9437399+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-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-29T04:03:02.9437399+00:00",
"date_last_job": "2026-08-29T04:03:02.9437399+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-29T04:03:02.9437399+00:00",
"modified_dateutc": "2026-08-29T04:03:02.9437399+00:00",
"is_mobile_installation": true
},
"job_type_id": "74b69c5f-14a0-41ba-8f2f-112c8f417910",
"job_type_code": "sample string 7",
"job_type": {
"id": "1f42857c-480d-4371-9720-7a6d7ba77548",
"name": "sample string 2",
"sales_organization_id": "fd85113d-e546-4d94-9dff-1ab80f8ccaef",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-29T04:03:02.9437399+00:00",
"code": "sample string 7"
},
"job_priority_id": "a5482b1c-bf7d-4571-80f6-2b959b77827f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "baee48ca-e61c-4df0-9cd6-655a539f6d96",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f6fc8474-0261-4002-9f87-883c7dc188ee",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "da2dd970-d465-4536-b30b-61b8921c27a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9155a071-a125-4bef-950b-f007bceb93e1",
"db_currency_id": "de7342a5-49c3-492a-98af-d3d77b9b15d4",
"db_language_id": "5f213312-85a2-4e86-8680-54b07eee176a",
"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-29T04:03:02.9437399+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-29T04:03:02.9437399+00:00"
},
"job_status_id": "100f65bb-2875-470e-8ef7-374fa176cb6f",
"job_status_code": "sample string 11",
"db_address_id": "c52aaf3b-c89a-49c7-b50a-c7b883b5ea4b",
"contact_id": "b51b53c4-ac1e-4dbe-88e8-d19adf0b7feb",
"requested_by_company_id": "67e4be76-f7d0-4690-ab7e-c16e548b67af",
"requested_by_contact_id": "d9f77804-23ba-4722-909b-a7e324a589e4",
"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-29T04:03:02.9437399+00:00",
"due_date": "2026-08-29T04:03:02.9437399+00:00",
"date_create": "2026-08-29T04:03:02.9437399+00:00",
"date_update": "2026-08-29T04:03:02.9437399+00:00",
"date_closed": "2026-08-29T04:03:02.9437399+00:00",
"suggested_user_id": "f9dbbcc9-3cc3-470e-b5f3-e678bcbfd3ff",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2c32b6b4-033b-4ce6-b175-fa070617b1fa",
"db_language_id": "a1b6dc2c-3ce0-44cf-b5e6-fa715daeda51",
"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-29T04:03:02.9437399+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3a5ef388-5370-4e73-800e-6c731bc054a6",
"sales_organization": {
"id": "da2dd970-d465-4536-b30b-61b8921c27a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9155a071-a125-4bef-950b-f007bceb93e1",
"db_currency_id": "de7342a5-49c3-492a-98af-d3d77b9b15d4",
"db_language_id": "5f213312-85a2-4e86-8680-54b07eee176a",
"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-29T04:03:02.9437399+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "82607031-f61f-4691-92e8-3f28929daaab",
"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": "b5d8d8ba-c041-450d-9386-fec39fb9904e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-29T04:03:02.9437399+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "32b8b884-9fd7-451f-8f33-8caeb40f6d6e"
},
"suggested_date_start": "2026-08-29T04:03:02.9437399+00:00",
"skill_id": "0ecab0ed-db29-48b8-94e7-0e92d42cb641",
"skill_code": "sample string 32",
"skill": {
"id": "611c37d5-15a2-46af-9efb-1a1de8a45a12",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9278573a-deb8-4ae9-b11a-68939bd2af70",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "da2dd970-d465-4536-b30b-61b8921c27a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9155a071-a125-4bef-950b-f007bceb93e1",
"db_currency_id": "de7342a5-49c3-492a-98af-d3d77b9b15d4",
"db_language_id": "5f213312-85a2-4e86-8680-54b07eee176a",
"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-29T04:03:02.9437399+00:00"
},
"modified_dateutc": "2026-08-29T04:03:02.9437399+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fa8faee3-debb-4d92-9970-cc8ec19863b5",
"date_reported_by_company": "2026-08-29T04:03:02.9437399+00:00",
"id2": 36,
"company_id": "97d9da02-999d-47b8-bb28-15969b76881d",
"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": "0f72ae1c-1720-477d-b8d7-72c50ed57f05",
"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-29T04:03:02.9437399+00:00"
},
"work_instruction_details_id": "c0fa0f1f-6cb4-441a-b277-6e1a31ba285c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "bc1a05ba-5f13-4738-a598-bf0278bd3bd0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5a57e0d4-dde4-41b2-b57c-0dca9511dd57",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-29T04:03:02.9437399+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": "a2da1456-c24e-4fd7-8055-a76743afbe63",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-29T04:03:02.9437399+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.