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": "439116d7-26ff-44b7-bb14-362f7e7c4143",
"jobs_id": "11996e5d-e2d2-4a39-a5ab-d79df50113e7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ed7937ad-5522-4a25-963e-ac0f75d0e81c",
"_parent_id": "3b4c844a-58c7-41a5-8e0e-6fe60515e4ee",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b6a37642-2fc3-452e-afec-0e4e0b43b8e7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "dbb78359-9ea8-4d5b-af2a-3659ec10d3e2",
"_parent_id": "96337b28-5a1d-4a99-abfa-5e4a6fedf302",
"root_parent_id": "143e8efe-d4b0-4980-b69b-a31c6e3513b1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c4f8e4aa-f3af-4151-8bf1-132b18cc58a8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0e2b8a04-08ce-40e7-a1e3-d1bdff331ef3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "16727ae9-aa55-42e7-a448-402c014ccc00",
"_parent_code": "sample string 6",
"sales_organization_id": "ea4e5a66-6340-40fb-b044-b2ef5fa6e73a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b7caf322-f8e9-493c-b552-e29893444f73",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8837e5b3-c7c0-4f8c-a660-80d9b60d5b0a",
"db_currency_id": "e26f60fd-f665-4176-9df0-b7c47a7e5b94",
"db_language_id": "14b4e055-3373-4c16-81a2-71f6e0e831df",
"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-04T19:22:01.2108983+00:00"
},
"modified_dateutc": "2026-09-04T19:22:01.2108983+00:00"
},
"equipment_model_id": "87998499-628c-467b-be62-b1342af5051e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4282c6b8-d64a-4042-9161-68e954f5e9ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "35aa1cf6-f104-4f9d-9384-ee74c5e819f4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f6588a21-bf5a-46a0-a126-f4c7621a8f81",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2b4f784c-4671-4de5-9676-3ba8edce216c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b7caf322-f8e9-493c-b552-e29893444f73",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8837e5b3-c7c0-4f8c-a660-80d9b60d5b0a",
"db_currency_id": "e26f60fd-f665-4176-9df0-b7c47a7e5b94",
"db_language_id": "14b4e055-3373-4c16-81a2-71f6e0e831df",
"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-04T19:22:01.2108983+00:00"
},
"modified_dateutc": "2026-09-04T19:22:01.2108983+00:00"
},
"equipment_family_id": "00ff4bc5-b87f-41b1-b5fd-8350d3761729",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0e2b8a04-08ce-40e7-a1e3-d1bdff331ef3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "16727ae9-aa55-42e7-a448-402c014ccc00",
"_parent_code": "sample string 6",
"sales_organization_id": "ea4e5a66-6340-40fb-b044-b2ef5fa6e73a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b7caf322-f8e9-493c-b552-e29893444f73",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8837e5b3-c7c0-4f8c-a660-80d9b60d5b0a",
"db_currency_id": "e26f60fd-f665-4176-9df0-b7c47a7e5b94",
"db_language_id": "14b4e055-3373-4c16-81a2-71f6e0e831df",
"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-04T19:22:01.2108983+00:00"
},
"modified_dateutc": "2026-09-04T19:22:01.2108983+00:00"
},
"date_in_production_since": "2026-09-04T19:22:01.2108983+00:00",
"date_out_of_production_since": "2026-09-04T19:22:01.2108983+00:00",
"date_end_support": "2026-09-04T19:22:01.2108983+00:00",
"sales_organization_id": "6205023e-00c2-45ea-944d-ea89d6774151",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b7caf322-f8e9-493c-b552-e29893444f73",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8837e5b3-c7c0-4f8c-a660-80d9b60d5b0a",
"db_currency_id": "e26f60fd-f665-4176-9df0-b7c47a7e5b94",
"db_language_id": "14b4e055-3373-4c16-81a2-71f6e0e831df",
"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-04T19:22:01.2108983+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-04T19:22:01.2108983+00:00"
},
"project_status_id": "3b650f15-0f88-4107-850c-36ea9cda7c1c",
"project_status_code": "sample string 10",
"project_status": {
"id": "4022d939-9e4c-4786-ab36-b2a1127241dc",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "70512e52-c4f7-45a6-aa35-a92eb6d44949",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b7caf322-f8e9-493c-b552-e29893444f73",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8837e5b3-c7c0-4f8c-a660-80d9b60d5b0a",
"db_currency_id": "e26f60fd-f665-4176-9df0-b7c47a7e5b94",
"db_language_id": "14b4e055-3373-4c16-81a2-71f6e0e831df",
"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-04T19:22:01.2108983+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-04T19:22:01.2108983+00:00"
},
"company_id": "eb5d9393-8640-4e12-8e8f-ca51fc7f86bf",
"company_code": "sample string 12",
"db_address_id": "106e476e-949b-4cae-b654-8b523c6d9f73",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0cf5dd54-e89e-47ff-9ac6-ed686e00fe7b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d02663e8-75ce-48de-b563-bb99e780db3d",
"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-04T19:22:01.2108983+00:00",
"date_create": "2026-09-04T19:22:01.2108983+00:00",
"date_update": "2026-09-04T19:22:01.2108983+00:00",
"updated_by_user_id": "962a39af-38a4-4cfe-9618-00745ab12d91",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-04T19:22:01.2108983+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-04T19:22:01.2108983+00:00",
"date_last_job": "2026-09-04T19:22:01.2108983+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-04T19:22:01.2108983+00:00",
"modified_dateutc": "2026-09-04T19:22:01.2108983+00:00",
"is_mobile_installation": true
},
"job_type_id": "f556d108-e9b6-4061-a391-14e8e3c69c60",
"job_type_code": "sample string 7",
"job_type": {
"id": "6d36f735-2984-4f52-8709-f407b1ca3e40",
"name": "sample string 2",
"sales_organization_id": "db9a3921-ddd6-4931-bb21-8a78b23d12e2",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-04T19:22:01.2108983+00:00",
"code": "sample string 7"
},
"job_priority_id": "eaaa771c-22b3-4ce9-9f5c-3ec7e4c9b9b6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6e5bc510-6f95-4fef-a875-de43ebedc174",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a42f47cf-3353-45e1-967e-2d3ef1e5a223",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b7caf322-f8e9-493c-b552-e29893444f73",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8837e5b3-c7c0-4f8c-a660-80d9b60d5b0a",
"db_currency_id": "e26f60fd-f665-4176-9df0-b7c47a7e5b94",
"db_language_id": "14b4e055-3373-4c16-81a2-71f6e0e831df",
"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-04T19:22:01.2108983+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-04T19:22:01.2108983+00:00"
},
"job_status_id": "71390153-41eb-44cb-b4c3-e1d3ab364700",
"job_status_code": "sample string 11",
"db_address_id": "3c9a0799-2821-4422-a74f-cb2099a42e8c",
"contact_id": "9a113495-e1be-43c1-8512-cfbf617d3cf9",
"requested_by_company_id": "066b2766-633f-408d-aa1f-8e55abf0ed86",
"requested_by_contact_id": "dbe2c47b-d1ef-4cb9-93fa-c684626d1661",
"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-04T19:22:01.2108983+00:00",
"due_date": "2026-09-04T19:22:01.2108983+00:00",
"date_create": "2026-09-04T19:22:01.2108983+00:00",
"date_update": "2026-09-04T19:22:01.2108983+00:00",
"date_closed": "2026-09-04T19:22:01.2108983+00:00",
"suggested_user_id": "486f32a8-aede-44f0-bf04-9d7652ef20bb",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "86aab909-c0f1-4f0c-b54c-6c9f57fb61b7",
"db_language_id": "663317eb-9329-42b1-8020-f53805fdf992",
"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-04T19:22:01.2108983+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6d9d92bc-5bd4-4d52-b5cd-4abdc78cb690",
"sales_organization": {
"id": "b7caf322-f8e9-493c-b552-e29893444f73",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8837e5b3-c7c0-4f8c-a660-80d9b60d5b0a",
"db_currency_id": "e26f60fd-f665-4176-9df0-b7c47a7e5b94",
"db_language_id": "14b4e055-3373-4c16-81a2-71f6e0e831df",
"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-04T19:22:01.2108983+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4c1f364d-303c-485c-ba0a-fa679d276112",
"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": "d6387da5-f6ca-4814-9fd6-81ff71f7a768",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-04T19:22:01.2108983+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f515b0b0-3420-4e32-a724-ab6692427918"
},
"suggested_date_start": "2026-09-04T19:22:01.2108983+00:00",
"skill_id": "c2c52035-4d27-4eda-b126-178bbac4cf5c",
"skill_code": "sample string 32",
"skill": {
"id": "37b6bec6-0a02-4bad-a94d-17196e343478",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9a02d0fc-7e68-4035-ba61-75d49a73517a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b7caf322-f8e9-493c-b552-e29893444f73",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8837e5b3-c7c0-4f8c-a660-80d9b60d5b0a",
"db_currency_id": "e26f60fd-f665-4176-9df0-b7c47a7e5b94",
"db_language_id": "14b4e055-3373-4c16-81a2-71f6e0e831df",
"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-04T19:22:01.2108983+00:00"
},
"modified_dateutc": "2026-09-04T19:22:01.2108983+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0f74b740-da7b-4809-8280-ded8ee76f0fe",
"date_reported_by_company": "2026-09-04T19:22:01.2108983+00:00",
"id2": 36,
"company_id": "b5d09f73-f260-4f43-96cd-1ee771281f8a",
"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": "f92dc511-5357-4d85-a00e-6db55e1f171e",
"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-04T19:22:01.2108983+00:00"
},
"work_instruction_details_id": "b177074f-c159-4f1b-8070-1b9efd3188f4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8fccd7e6-eeaf-4acd-95fb-abbf1c777f73",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6171dacb-9bf0-40e6-91cc-f8f2d19b5c09",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-04T19:22:01.2108983+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": "3228f6a2-f03b-4654-b1ee-e67a5745486e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-04T19:22:01.2265255+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.