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": "045885ca-ba56-4ff7-bb38-9d19c2d2a2e6",
"jobs_id": "2d38537d-a1d3-4397-a87e-f56a65366880",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "55bd1f5b-b734-454c-b98d-1594e8571f24",
"_parent_id": "5d7f478c-0b66-4bd3-9116-81c208ef3665",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c2d0bb41-05c4-4157-b311-446159f81451",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f424144a-fbd0-4125-a002-2f57ce289fcc",
"_parent_id": "1655a0d9-4ea0-4456-9aa1-e32b2eea263e",
"root_parent_id": "3df03435-81da-43b0-a3c8-a60c734eea92",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c5b321e0-70c9-43c4-a6f9-d5e22bebc44a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "98e32a06-af92-4042-a1f6-1df2d39ebc46",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c87ea3d9-a536-415e-8b71-694a845ca1a0",
"_parent_code": "sample string 6",
"sales_organization_id": "8c019aee-128a-4201-aeeb-8f6f197a54a9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1a1253b8-0437-4ecf-bf38-bec5fbffd58a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d095dff2-ac27-4439-acef-2f2aece724fa",
"db_currency_id": "b42bfda4-8042-4776-a57e-3c7c4970c86f",
"db_language_id": "4d7a3791-8e89-4376-a98e-d85a89733857",
"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-06-06T09:21:01.5595857+00:00"
},
"modified_dateutc": "2026-06-06T09:21:01.5595857+00:00"
},
"equipment_model_id": "caa98ca4-624c-4203-bc79-f69fcbecf9d5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "87754226-fe4c-4d4d-be10-727e91a49367",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f1e09d5b-a282-4ee9-aa7f-fbec5ec27a8e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "099fbfd9-7dc8-4773-80eb-bf59edf503a7",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "148410fd-d76f-4214-bacf-dfdaf4eec3b0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1a1253b8-0437-4ecf-bf38-bec5fbffd58a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d095dff2-ac27-4439-acef-2f2aece724fa",
"db_currency_id": "b42bfda4-8042-4776-a57e-3c7c4970c86f",
"db_language_id": "4d7a3791-8e89-4376-a98e-d85a89733857",
"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-06-06T09:21:01.5595857+00:00"
},
"modified_dateutc": "2026-06-06T09:21:01.5595857+00:00"
},
"equipment_family_id": "d486ed01-8671-45d3-9b6c-a8acc84f538d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "98e32a06-af92-4042-a1f6-1df2d39ebc46",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c87ea3d9-a536-415e-8b71-694a845ca1a0",
"_parent_code": "sample string 6",
"sales_organization_id": "8c019aee-128a-4201-aeeb-8f6f197a54a9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1a1253b8-0437-4ecf-bf38-bec5fbffd58a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d095dff2-ac27-4439-acef-2f2aece724fa",
"db_currency_id": "b42bfda4-8042-4776-a57e-3c7c4970c86f",
"db_language_id": "4d7a3791-8e89-4376-a98e-d85a89733857",
"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-06-06T09:21:01.5595857+00:00"
},
"modified_dateutc": "2026-06-06T09:21:01.5595857+00:00"
},
"date_in_production_since": "2026-06-06T09:21:01.5595857+00:00",
"date_out_of_production_since": "2026-06-06T09:21:01.5595857+00:00",
"date_end_support": "2026-06-06T09:21:01.5595857+00:00",
"sales_organization_id": "98e7b45f-01a9-4a3f-8f15-391208b68846",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1a1253b8-0437-4ecf-bf38-bec5fbffd58a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d095dff2-ac27-4439-acef-2f2aece724fa",
"db_currency_id": "b42bfda4-8042-4776-a57e-3c7c4970c86f",
"db_language_id": "4d7a3791-8e89-4376-a98e-d85a89733857",
"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-06-06T09:21:01.5595857+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-06-06T09:21:01.5595857+00:00"
},
"project_status_id": "a8190c2a-068f-4bce-bec2-5b7df789bac9",
"project_status_code": "sample string 10",
"project_status": {
"id": "a6d07edd-951d-4bc5-8c44-e63f2c5bb52e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "92675527-06df-40f9-bdc7-7fe07ac8dcc3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1a1253b8-0437-4ecf-bf38-bec5fbffd58a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d095dff2-ac27-4439-acef-2f2aece724fa",
"db_currency_id": "b42bfda4-8042-4776-a57e-3c7c4970c86f",
"db_language_id": "4d7a3791-8e89-4376-a98e-d85a89733857",
"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-06-06T09:21:01.5595857+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-06T09:21:01.5595857+00:00"
},
"company_id": "ef442405-aa73-4515-aae6-b76504a34f3d",
"company_code": "sample string 12",
"db_address_id": "7f8e31d5-04b4-4a8f-9e3d-2bd7173b85fc",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "638c2a51-a13a-41f9-b723-7b045d073f2e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "732a4283-e212-4558-bf6b-ff13c4617529",
"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-06-06T09:21:01.5595857+00:00",
"date_create": "2026-06-06T09:21:01.5595857+00:00",
"date_update": "2026-06-06T09:21:01.5595857+00:00",
"updated_by_user_id": "eade1cbe-03bc-47b2-8b60-c9fe845eafef",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-06T09:21:01.5595857+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-06-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-06T09:21:01.5595857+00:00",
"date_last_job": "2026-06-06T09:21:01.5595857+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-06T09:21:01.5595857+00:00",
"modified_dateutc": "2026-06-06T09:21:01.5595857+00:00",
"is_mobile_installation": true
},
"job_type_id": "d26742da-4826-4b05-b8e4-8016a4cbaee4",
"job_type_code": "sample string 7",
"job_type": {
"id": "58bf6cae-1846-4b3c-a50d-53cceea7f713",
"name": "sample string 2",
"sales_organization_id": "6db751ab-3768-40c7-b267-b45c271e60bf",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-06T09:21:01.5595857+00:00",
"code": "sample string 7"
},
"job_priority_id": "cd2a30d2-7cb4-472f-8e3d-a42a4724b6e9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f869841a-f937-4fdb-96ad-f281c072b0cf",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5a727f72-de37-4e2c-b3df-50b2ee70c651",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1a1253b8-0437-4ecf-bf38-bec5fbffd58a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d095dff2-ac27-4439-acef-2f2aece724fa",
"db_currency_id": "b42bfda4-8042-4776-a57e-3c7c4970c86f",
"db_language_id": "4d7a3791-8e89-4376-a98e-d85a89733857",
"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-06-06T09:21:01.5595857+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-06T09:21:01.5595857+00:00"
},
"job_status_id": "a99b0643-1a83-4494-8784-5cffed4e264e",
"job_status_code": "sample string 11",
"db_address_id": "d82cf26a-46f5-4fac-86c2-ff301304a915",
"contact_id": "59331d8b-9993-4a6c-ac84-94d1b251d53d",
"requested_by_company_id": "3d7d7461-80bd-4b0f-9424-836c0ef1f0f0",
"requested_by_contact_id": "40254e62-c180-4fbc-81cd-9c0767133c0b",
"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-06-06T09:21:01.5595857+00:00",
"due_date": "2026-06-06T09:21:01.5595857+00:00",
"date_create": "2026-06-06T09:21:01.5595857+00:00",
"date_update": "2026-06-06T09:21:01.5595857+00:00",
"date_closed": "2026-06-06T09:21:01.5595857+00:00",
"suggested_user_id": "4a204c72-8ff5-41a0-8709-7f434a3318a4",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "43d8043c-d5e4-42fd-bc87-59739fb3c991",
"db_language_id": "6e1ba7c7-bdc6-48c6-9f16-c8b3f80185df",
"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-06-06T09:21:01.5595857+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7d860fa9-1bb6-48e9-98ac-ef8551eaf051",
"sales_organization": {
"id": "1a1253b8-0437-4ecf-bf38-bec5fbffd58a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d095dff2-ac27-4439-acef-2f2aece724fa",
"db_currency_id": "b42bfda4-8042-4776-a57e-3c7c4970c86f",
"db_language_id": "4d7a3791-8e89-4376-a98e-d85a89733857",
"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-06-06T09:21:01.5595857+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f437fdda-3e5a-4bdf-93a8-69949bbbcb25",
"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": "5d46681b-bd8f-41be-a2f8-ba5fc86c79f1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-06T09:21:01.5595857+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f21ac39a-cdea-4aed-b2fb-2366a34e0b21"
},
"suggested_date_start": "2026-06-06T09:21:01.5595857+00:00",
"skill_id": "eb7eaf1c-c634-403e-96db-c9b340607f63",
"skill_code": "sample string 32",
"skill": {
"id": "813ebf84-1d09-42fd-ae4e-9df990a6ff13",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3780ad6b-23d5-4f4a-a28c-d08c4111c8da",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1a1253b8-0437-4ecf-bf38-bec5fbffd58a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d095dff2-ac27-4439-acef-2f2aece724fa",
"db_currency_id": "b42bfda4-8042-4776-a57e-3c7c4970c86f",
"db_language_id": "4d7a3791-8e89-4376-a98e-d85a89733857",
"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-06-06T09:21:01.5595857+00:00"
},
"modified_dateutc": "2026-06-06T09:21:01.5595857+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3f47896d-435a-447b-b74c-c3698ee0ff67",
"date_reported_by_company": "2026-06-06T09:21:01.5595857+00:00",
"id2": 36,
"company_id": "1cbb9ade-73be-4df8-8852-3323e9b4ab66",
"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": "f0d3fbb8-5706-4b4f-a214-e3a1fb244272",
"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-06-06T09:21:01.5595857+00:00"
},
"work_instruction_details_id": "6879eab8-09ac-4151-a12f-9c143373c163",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "bdc7b596-eb9e-43d1-816e-a68f5c7b09ad",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8ef5a7c3-0049-4891-8498-1bc954a027eb",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-06T09:21:01.5595857+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": "d9c8dd6b-bf18-497f-aac5-8c48b57eb740",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-06T09:21:01.5595857+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.