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": "f7717d39-ce69-4452-9ffa-959bb6ef3459",
"jobs_id": "ff9a6a0b-7193-4d90-baba-962b8cbe3980",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3ed35def-c9af-4f54-a240-40cb12fb88f5",
"_parent_id": "35ee31b7-b773-4333-8a9b-987ba692c923",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "308da358-5011-4afc-bfcf-860e1e91623f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "10d3fe98-239a-411e-aee5-dfadcf751f26",
"_parent_id": "c475b1ee-9913-441f-adf7-9e59e15a0bc0",
"root_parent_id": "299df99f-bda9-407e-929a-6fdc83eb16e2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ab61a04b-4916-4aca-b632-065552731a12",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6530c67a-bf62-4b5b-ac3d-4a346b7fab5b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f5a6a49b-8312-4467-88c6-ebeb6ab1cb37",
"_parent_code": "sample string 6",
"sales_organization_id": "2b86d2fb-19c9-47a7-bbaf-4d4ab043da5d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1ed604c4-b644-4e8b-8181-e791d5197897",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a27771b2-6efd-4c06-aea3-5ed6337e2fb4",
"db_currency_id": "ddf27f40-9c53-4d99-be9c-51f24b75a68a",
"db_language_id": "cd0a9efd-e3c6-473c-8c13-c8b8dae51e83",
"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-03-02T04:47:46.7536482+00:00"
},
"modified_dateutc": "2026-03-02T04:47:46.7536482+00:00"
},
"equipment_model_id": "3124e127-199f-4f6b-b0e8-d72909d4d220",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9bdb886a-1b17-4c9e-a0ef-248c21886a31",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "892b33a0-7bf0-465e-a6ab-1ff9c59764a9",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "46957034-1558-463c-bb22-9032a537c543",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "70e59f58-a21e-4215-9d1f-14b37801e218",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1ed604c4-b644-4e8b-8181-e791d5197897",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a27771b2-6efd-4c06-aea3-5ed6337e2fb4",
"db_currency_id": "ddf27f40-9c53-4d99-be9c-51f24b75a68a",
"db_language_id": "cd0a9efd-e3c6-473c-8c13-c8b8dae51e83",
"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-03-02T04:47:46.7536482+00:00"
},
"modified_dateutc": "2026-03-02T04:47:46.7536482+00:00"
},
"equipment_family_id": "41234f7e-3fd8-48f1-803f-2dafe881a2a9",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6530c67a-bf62-4b5b-ac3d-4a346b7fab5b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f5a6a49b-8312-4467-88c6-ebeb6ab1cb37",
"_parent_code": "sample string 6",
"sales_organization_id": "2b86d2fb-19c9-47a7-bbaf-4d4ab043da5d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1ed604c4-b644-4e8b-8181-e791d5197897",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a27771b2-6efd-4c06-aea3-5ed6337e2fb4",
"db_currency_id": "ddf27f40-9c53-4d99-be9c-51f24b75a68a",
"db_language_id": "cd0a9efd-e3c6-473c-8c13-c8b8dae51e83",
"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-03-02T04:47:46.7536482+00:00"
},
"modified_dateutc": "2026-03-02T04:47:46.7536482+00:00"
},
"date_in_production_since": "2026-03-02T04:47:46.7536482+00:00",
"date_out_of_production_since": "2026-03-02T04:47:46.7536482+00:00",
"date_end_support": "2026-03-02T04:47:46.7536482+00:00",
"sales_organization_id": "ca34fba6-6158-4920-8a9e-7a44aeb4001f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1ed604c4-b644-4e8b-8181-e791d5197897",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a27771b2-6efd-4c06-aea3-5ed6337e2fb4",
"db_currency_id": "ddf27f40-9c53-4d99-be9c-51f24b75a68a",
"db_language_id": "cd0a9efd-e3c6-473c-8c13-c8b8dae51e83",
"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-03-02T04:47:46.7536482+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-03-02T04:47:46.7536482+00:00"
},
"project_status_id": "91110cc4-d91a-4945-938f-ec5908095852",
"project_status_code": "sample string 10",
"project_status": {
"id": "3f70ef01-a589-482a-ae05-6d891c922cb4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3c79b89a-714f-4ae2-8dfb-9d2551ef1ec5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1ed604c4-b644-4e8b-8181-e791d5197897",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a27771b2-6efd-4c06-aea3-5ed6337e2fb4",
"db_currency_id": "ddf27f40-9c53-4d99-be9c-51f24b75a68a",
"db_language_id": "cd0a9efd-e3c6-473c-8c13-c8b8dae51e83",
"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-03-02T04:47:46.7536482+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-02T04:47:46.7536482+00:00"
},
"company_id": "21294bf3-b8dd-44b0-80aa-998cb469c913",
"company_code": "sample string 12",
"db_address_id": "229e78e2-d6be-47e2-a70d-893ed70b0676",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "dced8c72-8c8b-4796-83b8-813a64ef105c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "43ca2b36-b179-4f22-a96b-60fe9ef233c8",
"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-03-02T04:47:46.7536482+00:00",
"date_create": "2026-03-02T04:47:46.7536482+00:00",
"date_update": "2026-03-02T04:47:46.7536482+00:00",
"updated_by_user_id": "a7404694-68d2-4f35-a3cf-d87b0df9508d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-02T04:47:46.7536482+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-03-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-02T04:47:46.7536482+00:00",
"date_last_job": "2026-03-02T04:47:46.7536482+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-02T04:47:46.7536482+00:00",
"modified_dateutc": "2026-03-02T04:47:46.7536482+00:00",
"is_mobile_installation": true
},
"job_type_id": "7dd9ba8e-0d03-4bc7-94c2-d9d0b7e63158",
"job_type_code": "sample string 7",
"job_type": {
"id": "84a48eba-61d0-414b-93d5-64d169b82989",
"name": "sample string 2",
"sales_organization_id": "cee22165-9b3f-46ef-b1ef-b9cd0a089fab",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-02T04:47:46.7536482+00:00",
"code": "sample string 7"
},
"job_priority_id": "fb0181ef-0128-4dc2-913b-e60ca0351b42",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "557b03ce-0bf1-49bd-948c-9fd1d5c625d1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "aeaa90b6-efb4-4837-b157-3c0c8f48421f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1ed604c4-b644-4e8b-8181-e791d5197897",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a27771b2-6efd-4c06-aea3-5ed6337e2fb4",
"db_currency_id": "ddf27f40-9c53-4d99-be9c-51f24b75a68a",
"db_language_id": "cd0a9efd-e3c6-473c-8c13-c8b8dae51e83",
"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-03-02T04:47:46.7536482+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-02T04:47:46.7536482+00:00"
},
"job_status_id": "eed80289-3568-488e-9191-25c3e0ad05e0",
"job_status_code": "sample string 11",
"db_address_id": "3f74bf5c-cde1-4613-aa5f-be0e8a9e2eb2",
"contact_id": "03c09004-152d-46c9-9be3-c7e9318f8e92",
"requested_by_company_id": "0c97e6cc-1e93-483c-ab10-1bb1e07dcb62",
"requested_by_contact_id": "31298093-d469-4547-908f-15a88fa0696e",
"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-03-02T04:47:46.7536482+00:00",
"due_date": "2026-03-02T04:47:46.7536482+00:00",
"date_create": "2026-03-02T04:47:46.7536482+00:00",
"date_update": "2026-03-02T04:47:46.7536482+00:00",
"date_closed": "2026-03-02T04:47:46.7536482+00:00",
"suggested_user_id": "5ef56b39-c9bb-457e-963b-77e65c5c0449",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "72083c3a-bfbd-4638-ab09-8b30a0cb1e2c",
"db_language_id": "742651df-de17-4378-8a17-4678a6087070",
"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-03-02T04:47:46.9567852+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "cf375bf2-acd0-40b5-9029-a6c235035e7d",
"sales_organization": {
"id": "1ed604c4-b644-4e8b-8181-e791d5197897",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a27771b2-6efd-4c06-aea3-5ed6337e2fb4",
"db_currency_id": "ddf27f40-9c53-4d99-be9c-51f24b75a68a",
"db_language_id": "cd0a9efd-e3c6-473c-8c13-c8b8dae51e83",
"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-03-02T04:47:46.7536482+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5304d3c9-cc3f-4d5c-9df5-7ef6680148c4",
"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": "964729a9-ea53-4eed-8b69-a868c5cc3687",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-02T04:47:46.9567852+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ead0d5fd-5081-46b5-b34e-ce049b4a8d3b"
},
"suggested_date_start": "2026-03-02T04:47:46.9567852+00:00",
"skill_id": "1b47c773-db3f-41a2-b322-a433b80bef73",
"skill_code": "sample string 32",
"skill": {
"id": "38ee2f89-56ca-4a83-a3cb-975dfa1de187",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c231d268-6d93-4a76-beeb-1fe3343b13e8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1ed604c4-b644-4e8b-8181-e791d5197897",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a27771b2-6efd-4c06-aea3-5ed6337e2fb4",
"db_currency_id": "ddf27f40-9c53-4d99-be9c-51f24b75a68a",
"db_language_id": "cd0a9efd-e3c6-473c-8c13-c8b8dae51e83",
"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-03-02T04:47:46.7536482+00:00"
},
"modified_dateutc": "2026-03-02T04:47:46.9567852+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2dd980d9-ba04-4fbe-b23b-53d79281e3be",
"date_reported_by_company": "2026-03-02T04:47:46.9567852+00:00",
"id2": 36,
"company_id": "f1229f90-f3ea-4389-a634-55bc3abbae8b",
"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": "54921916-36d0-428d-97a8-4fea764786b8",
"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-03-02T04:47:46.9567852+00:00"
},
"work_instruction_details_id": "e054e7c0-56d4-4b12-8460-749ff6a31087",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d888d304-710b-454a-a0cd-f8f0394e2374",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ff67a602-8afb-45b7-841d-b109f324f69b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-02T04:47:46.9567852+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": "aad372ba-8d4d-44c7-83bf-499b0a2b6042",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-02T04:47:46.9567852+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.