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": "16dcae88-46e7-4ab3-9e1e-26ab79ddc8bb",
"jobs_id": "9bb6b1c2-9b16-4be9-ac41-f0e8e95020ff",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8c0a4c44-ef9f-4841-a3e8-57e6f6d809cc",
"_parent_id": "645ac853-6ea4-4436-b05a-3e9074c1fdbe",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "eee551c8-0046-4a54-ac57-1b36fcc72cb7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "af7b8956-f15d-466b-891f-a592ac8ca241",
"_parent_id": "14439c4c-a836-4217-9949-e766fbd638eb",
"root_parent_id": "b3e62fc1-c921-460d-941c-925cc8f9c433",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ebff20b2-3fda-48bf-9c1b-b33410a6f92a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e872308a-1f0a-49fa-a424-0f33da201ad4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "be13b796-7c54-45e7-9900-849d811a0864",
"_parent_code": "sample string 6",
"sales_organization_id": "35e276e7-d804-4cba-ac27-e1c82d5323a0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a6beaa83-ce3e-4928-b009-83baaf7081fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e2a612a-a7fa-49b8-a7ac-c9117d99abb7",
"db_currency_id": "1d27c1f4-1952-430c-b1d2-6d91563aad22",
"db_language_id": "5e6358bc-0f15-46af-a2d5-b7f856ae59db",
"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-21T22:57:37.6989395+00:00"
},
"modified_dateutc": "2026-05-21T22:57:37.6989395+00:00"
},
"equipment_model_id": "34096a1e-426b-46ec-9d12-8844ede19cb2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1a8a83fe-711e-4fa3-a562-38a762cb27db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "14c8f7e3-0098-4250-944d-81bc5b8718df",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e4e7b325-f7ae-4de9-baa1-d3e58f4518e7",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d0d488e7-f32b-4de6-b3ca-ea4ebb2c3ea8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a6beaa83-ce3e-4928-b009-83baaf7081fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e2a612a-a7fa-49b8-a7ac-c9117d99abb7",
"db_currency_id": "1d27c1f4-1952-430c-b1d2-6d91563aad22",
"db_language_id": "5e6358bc-0f15-46af-a2d5-b7f856ae59db",
"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-21T22:57:37.6989395+00:00"
},
"modified_dateutc": "2026-05-21T22:57:37.6989395+00:00"
},
"equipment_family_id": "e492e6da-f4f5-4edf-b7e1-baf96e80d9c5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e872308a-1f0a-49fa-a424-0f33da201ad4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "be13b796-7c54-45e7-9900-849d811a0864",
"_parent_code": "sample string 6",
"sales_organization_id": "35e276e7-d804-4cba-ac27-e1c82d5323a0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a6beaa83-ce3e-4928-b009-83baaf7081fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e2a612a-a7fa-49b8-a7ac-c9117d99abb7",
"db_currency_id": "1d27c1f4-1952-430c-b1d2-6d91563aad22",
"db_language_id": "5e6358bc-0f15-46af-a2d5-b7f856ae59db",
"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-21T22:57:37.6989395+00:00"
},
"modified_dateutc": "2026-05-21T22:57:37.6989395+00:00"
},
"date_in_production_since": "2026-05-21T22:57:37.6989395+00:00",
"date_out_of_production_since": "2026-05-21T22:57:37.6989395+00:00",
"date_end_support": "2026-05-21T22:57:37.6989395+00:00",
"sales_organization_id": "e116e4a3-cd9a-4f51-b9fd-f2b39097bba3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a6beaa83-ce3e-4928-b009-83baaf7081fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e2a612a-a7fa-49b8-a7ac-c9117d99abb7",
"db_currency_id": "1d27c1f4-1952-430c-b1d2-6d91563aad22",
"db_language_id": "5e6358bc-0f15-46af-a2d5-b7f856ae59db",
"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-21T22:57:37.6989395+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-21T22:57:37.6989395+00:00"
},
"project_status_id": "68e2cd75-3a24-40a2-a0e3-98e92fdd0182",
"project_status_code": "sample string 10",
"project_status": {
"id": "1fe077c4-1c27-4b4a-81bc-90ff1bfa64b5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "35997467-03b1-4bad-9751-ea6f81fe2df9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a6beaa83-ce3e-4928-b009-83baaf7081fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e2a612a-a7fa-49b8-a7ac-c9117d99abb7",
"db_currency_id": "1d27c1f4-1952-430c-b1d2-6d91563aad22",
"db_language_id": "5e6358bc-0f15-46af-a2d5-b7f856ae59db",
"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-21T22:57:37.6989395+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-21T22:57:37.6989395+00:00"
},
"company_id": "5feba4e0-4cff-4c3e-bc65-2cb896254bf8",
"company_code": "sample string 12",
"db_address_id": "063c3138-2a9c-4875-82dc-b9e31dbb1881",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "868b7d5e-f3a2-441f-99b6-8efd77c1d0ca",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "08233086-dc90-409a-87de-6337deb7b7fd",
"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-21T22:57:37.6989395+00:00",
"date_create": "2026-05-21T22:57:37.6989395+00:00",
"date_update": "2026-05-21T22:57:37.6989395+00:00",
"updated_by_user_id": "f6661275-6359-4908-a5cc-14012c6e7e08",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-21T22:57:37.6989395+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-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-21T22:57:37.6989395+00:00",
"date_last_job": "2026-05-21T22:57:37.6989395+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-21T22:57:37.6989395+00:00",
"modified_dateutc": "2026-05-21T22:57:37.6989395+00:00",
"is_mobile_installation": true
},
"job_type_id": "9df00d0c-72d1-49a2-888e-9ad97009a7a8",
"job_type_code": "sample string 7",
"job_type": {
"id": "3978a48c-ce71-46ab-be65-b34992f9bdea",
"name": "sample string 2",
"sales_organization_id": "5d97d860-3c90-48b7-aea7-4d5729e022dd",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-21T22:57:37.7145669+00:00",
"code": "sample string 7"
},
"job_priority_id": "176d7184-d557-4674-9b56-b07a31e00646",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2707d961-c03b-492d-ac18-123bb5afe82e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "dad64297-175a-4e93-8cb3-f720af813ad7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a6beaa83-ce3e-4928-b009-83baaf7081fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e2a612a-a7fa-49b8-a7ac-c9117d99abb7",
"db_currency_id": "1d27c1f4-1952-430c-b1d2-6d91563aad22",
"db_language_id": "5e6358bc-0f15-46af-a2d5-b7f856ae59db",
"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-21T22:57:37.6989395+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-21T22:57:37.7145669+00:00"
},
"job_status_id": "290fb631-ad19-4bc5-a9d9-dfc8fa890467",
"job_status_code": "sample string 11",
"db_address_id": "60bb833b-07c2-4886-a1ae-eb96471e2603",
"contact_id": "5dc95acc-0b31-444b-95ba-8f79e417e580",
"requested_by_company_id": "e4560a7b-233e-4514-b32b-f4396b87ea0b",
"requested_by_contact_id": "0b70c625-8d99-41fd-8963-c8be1ae5b529",
"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-21T22:57:37.7145669+00:00",
"due_date": "2026-05-21T22:57:37.7145669+00:00",
"date_create": "2026-05-21T22:57:37.7145669+00:00",
"date_update": "2026-05-21T22:57:37.7145669+00:00",
"date_closed": "2026-05-21T22:57:37.7145669+00:00",
"suggested_user_id": "e464c35b-4c33-4240-a14c-f07c02cb38ac",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ce304277-4bc6-49c0-9567-e91d24ab9681",
"db_language_id": "56336400-c3b1-4cde-afbf-25062ccc317a",
"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-21T22:57:37.7145669+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "665edeca-3b6b-407d-a529-5baee28aaa72",
"sales_organization": {
"id": "a6beaa83-ce3e-4928-b009-83baaf7081fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e2a612a-a7fa-49b8-a7ac-c9117d99abb7",
"db_currency_id": "1d27c1f4-1952-430c-b1d2-6d91563aad22",
"db_language_id": "5e6358bc-0f15-46af-a2d5-b7f856ae59db",
"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-21T22:57:37.6989395+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e686249f-8dd7-43bd-89b7-5e1252d2cda4",
"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": "4c4a36a8-f562-4782-9a4f-c0c0e920a216",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-21T22:57:37.7145669+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "53ed97be-bef0-4610-8983-498724adef95"
},
"suggested_date_start": "2026-05-21T22:57:37.7145669+00:00",
"skill_id": "be5fb204-acb5-495e-96a9-97051900f82b",
"skill_code": "sample string 32",
"skill": {
"id": "e08818e4-d17d-4bd9-8537-ec9ecf7fdb94",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "603e41a7-16a3-47f9-b165-7c1ecc886be0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a6beaa83-ce3e-4928-b009-83baaf7081fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e2a612a-a7fa-49b8-a7ac-c9117d99abb7",
"db_currency_id": "1d27c1f4-1952-430c-b1d2-6d91563aad22",
"db_language_id": "5e6358bc-0f15-46af-a2d5-b7f856ae59db",
"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-21T22:57:37.6989395+00:00"
},
"modified_dateutc": "2026-05-21T22:57:37.7145669+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "bea5f5b6-111d-47c6-8b2f-f67ae48191a5",
"date_reported_by_company": "2026-05-21T22:57:37.7145669+00:00",
"id2": 36,
"company_id": "542d27eb-2d85-4bb4-bece-efb8199548ce",
"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": "ee3a46b7-de2c-45a8-a288-b19b8c9c8e16",
"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-21T22:57:37.7145669+00:00"
},
"work_instruction_details_id": "255b9ff4-e865-4672-af8b-9172659e3a8d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7b1baba2-e008-479d-b2a2-779f28baced0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a25c1799-2fd2-41bc-a893-c3aa05e5da80",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-21T22:57:37.7145669+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": "7690126d-7715-4652-8410-566ce288ad8f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-21T22:57:37.7145669+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.