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": "f5a95434-1171-4e78-9bb1-91185a9b7de4",
"jobs_id": "7b228e7f-906b-4185-9017-d59ba5cf83b3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "43e7243e-4a63-4834-9afd-661010a7b106",
"_parent_id": "9e1361a3-8e32-423d-94bc-daa95bf311b8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a000f3bc-dfe0-498b-aa3d-f62db08e6c72",
"project_reference_back_office": "sample string 5",
"project": {
"id": "68495d11-6772-40fa-84b7-433ca7e723bb",
"_parent_id": "852b2fa7-94eb-4265-b698-f2a0fbce94f9",
"root_parent_id": "ff42065f-6676-415d-b182-6dfd601a2813",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2fcdaac6-2176-4360-8297-15bdcfdcbd59",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "49ca2d87-d7d2-4c18-98b7-bf118c8861fb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f64de084-77c0-4656-9d70-3d39426d8d9b",
"_parent_code": "sample string 6",
"sales_organization_id": "e4fd6ca5-07ec-45bd-9241-1d1967db6447",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ede1cd79-b0f4-4855-8611-04800bea5e2d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a25f383f-a647-405b-a376-1becb332c37c",
"db_currency_id": "a2d4fddd-8788-4368-acb2-bfb5dc46db9d",
"db_language_id": "dac3eed8-a190-49d3-ab8a-fdc3c5ff437d",
"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-13T18:55:59.8716924+00:00"
},
"modified_dateutc": "2026-09-13T18:55:59.8716924+00:00"
},
"equipment_model_id": "65ac33fd-7ee4-4cce-8a20-5bb6c4526810",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "66da2a6a-5a37-47b2-bb73-6f03f62a5c0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9dbe0cb2-daff-4c9c-bcf9-7ceb36779858",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "18821162-620b-4822-a2de-72b5aac00a2d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0d0eb9d0-ba09-43d7-bc79-88c08615d606",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ede1cd79-b0f4-4855-8611-04800bea5e2d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a25f383f-a647-405b-a376-1becb332c37c",
"db_currency_id": "a2d4fddd-8788-4368-acb2-bfb5dc46db9d",
"db_language_id": "dac3eed8-a190-49d3-ab8a-fdc3c5ff437d",
"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-13T18:55:59.8716924+00:00"
},
"modified_dateutc": "2026-09-13T18:55:59.8716924+00:00"
},
"equipment_family_id": "24147319-70f9-490c-ada7-2bd761c2c78a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "49ca2d87-d7d2-4c18-98b7-bf118c8861fb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f64de084-77c0-4656-9d70-3d39426d8d9b",
"_parent_code": "sample string 6",
"sales_organization_id": "e4fd6ca5-07ec-45bd-9241-1d1967db6447",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ede1cd79-b0f4-4855-8611-04800bea5e2d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a25f383f-a647-405b-a376-1becb332c37c",
"db_currency_id": "a2d4fddd-8788-4368-acb2-bfb5dc46db9d",
"db_language_id": "dac3eed8-a190-49d3-ab8a-fdc3c5ff437d",
"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-13T18:55:59.8716924+00:00"
},
"modified_dateutc": "2026-09-13T18:55:59.8716924+00:00"
},
"date_in_production_since": "2026-09-13T18:55:59.8716924+00:00",
"date_out_of_production_since": "2026-09-13T18:55:59.8716924+00:00",
"date_end_support": "2026-09-13T18:55:59.8716924+00:00",
"sales_organization_id": "a499388c-cd42-430a-bdcf-1f22b086aec9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ede1cd79-b0f4-4855-8611-04800bea5e2d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a25f383f-a647-405b-a376-1becb332c37c",
"db_currency_id": "a2d4fddd-8788-4368-acb2-bfb5dc46db9d",
"db_language_id": "dac3eed8-a190-49d3-ab8a-fdc3c5ff437d",
"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-13T18:55:59.8716924+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-13T18:55:59.8716924+00:00"
},
"project_status_id": "d05d3be0-5ba8-471c-964d-9588b8a1e587",
"project_status_code": "sample string 10",
"project_status": {
"id": "3d0d6d5b-e914-4308-b165-5c14879ac3a3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "aefb9ce7-0773-470d-94ee-f7de76874c88",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ede1cd79-b0f4-4855-8611-04800bea5e2d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a25f383f-a647-405b-a376-1becb332c37c",
"db_currency_id": "a2d4fddd-8788-4368-acb2-bfb5dc46db9d",
"db_language_id": "dac3eed8-a190-49d3-ab8a-fdc3c5ff437d",
"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-13T18:55:59.8716924+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-13T18:55:59.8716924+00:00"
},
"company_id": "9f3db619-6cb4-4c39-9687-3c0d7a9bc1e3",
"company_code": "sample string 12",
"db_address_id": "4b04ef47-a5d4-43fc-b9c2-994e3b71beba",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "27cea04f-9efe-4117-b3d2-b0765639491c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b8f62478-88ca-490c-882f-37d6aa977236",
"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-13T18:55:59.8716924+00:00",
"date_create": "2026-09-13T18:55:59.8716924+00:00",
"date_update": "2026-09-13T18:55:59.8716924+00:00",
"updated_by_user_id": "2d567d95-4d19-42a0-952d-0fb79d796668",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-13T18:55:59.8716924+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-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-13T18:55:59.8716924+00:00",
"date_last_job": "2026-09-13T18:55:59.8716924+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-13T18:55:59.8716924+00:00",
"modified_dateutc": "2026-09-13T18:55:59.8716924+00:00",
"is_mobile_installation": true
},
"job_type_id": "d0aa50ab-f097-49e2-be32-539c7d4fd6b8",
"job_type_code": "sample string 7",
"job_type": {
"id": "fafd381c-9b45-49a7-b837-ccabe848e176",
"name": "sample string 2",
"sales_organization_id": "80b924ac-e6d1-448f-9ce7-022c44d2c84e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-13T18:55:59.8716924+00:00",
"code": "sample string 7"
},
"job_priority_id": "2127282f-fc60-4ca5-81d6-6ab1973e483d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "45492054-3119-4b55-bda9-6de2a1c150bd",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "14603821-76be-4dfd-b57e-528dcce0c68d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ede1cd79-b0f4-4855-8611-04800bea5e2d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a25f383f-a647-405b-a376-1becb332c37c",
"db_currency_id": "a2d4fddd-8788-4368-acb2-bfb5dc46db9d",
"db_language_id": "dac3eed8-a190-49d3-ab8a-fdc3c5ff437d",
"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-13T18:55:59.8716924+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-13T18:55:59.8716924+00:00"
},
"job_status_id": "92e2415e-7970-4be2-90da-a4cc049a2fb1",
"job_status_code": "sample string 11",
"db_address_id": "b0ffb4b9-d259-42da-bc0c-46d46b28d449",
"contact_id": "30fb8656-3a8d-4c49-af8d-43f8c772beac",
"requested_by_company_id": "69988bcc-fe61-4eed-bfcb-b072b299c616",
"requested_by_contact_id": "e547761a-d90b-4583-8f9a-0ca323899005",
"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-13T18:55:59.8716924+00:00",
"due_date": "2026-09-13T18:55:59.8716924+00:00",
"date_create": "2026-09-13T18:55:59.8716924+00:00",
"date_update": "2026-09-13T18:55:59.8716924+00:00",
"date_closed": "2026-09-13T18:55:59.8716924+00:00",
"suggested_user_id": "fcd327d5-a8d6-417f-a950-dd2a3144c6f0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7b72fecf-bee2-4a28-ab3e-6115720737a6",
"db_language_id": "6e052cf0-5a02-47dc-be46-37be43365a85",
"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-13T18:55:59.8716924+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "fac476c1-2505-4883-9349-cb1a31ecba51",
"sales_organization": {
"id": "ede1cd79-b0f4-4855-8611-04800bea5e2d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a25f383f-a647-405b-a376-1becb332c37c",
"db_currency_id": "a2d4fddd-8788-4368-acb2-bfb5dc46db9d",
"db_language_id": "dac3eed8-a190-49d3-ab8a-fdc3c5ff437d",
"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-13T18:55:59.8716924+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "51a77ee0-c639-4c69-b64a-34379e8f5f5e",
"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": "216bdd14-ea17-4968-903d-1f5c5d87db0f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-13T18:55:59.8716924+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e7cdfad9-91ed-476e-b9ac-60ff46796def"
},
"suggested_date_start": "2026-09-13T18:55:59.8716924+00:00",
"skill_id": "ce9718f0-e2ff-475e-b712-2450be1e159f",
"skill_code": "sample string 32",
"skill": {
"id": "135b9fa1-5e39-4bfe-b99c-0517e3110722",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "771308fd-3aa2-4e1f-92a3-b818ae0bfff3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ede1cd79-b0f4-4855-8611-04800bea5e2d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a25f383f-a647-405b-a376-1becb332c37c",
"db_currency_id": "a2d4fddd-8788-4368-acb2-bfb5dc46db9d",
"db_language_id": "dac3eed8-a190-49d3-ab8a-fdc3c5ff437d",
"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-13T18:55:59.8716924+00:00"
},
"modified_dateutc": "2026-09-13T18:55:59.8716924+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c7ddadc6-021b-4b34-a52e-4fc0e433fca4",
"date_reported_by_company": "2026-09-13T18:55:59.8716924+00:00",
"id2": 36,
"company_id": "4ae1fd41-cd85-478d-90b0-f9d907c69581",
"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": "1afb1d5f-61db-4591-a4c2-20246b038fb7",
"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-13T18:55:59.8716924+00:00"
},
"work_instruction_details_id": "e89c52b0-8afc-446b-8cc6-a35f6150f63e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "cc5bdc38-cdf4-4361-b5ee-4224b80dc08f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3f4e44ba-1388-497b-b70b-d8944d305e9a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-13T18:55:59.8716924+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": "f56b4f7a-8005-4379-a7f7-cc9b34964fcd",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-13T18:55:59.8716924+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.