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": "06b61a2a-8a3e-4a44-ae4f-bb4c5bb4c857",
"jobs_id": "513a9466-311c-41fa-b9a3-94fe949392a1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d36fd78c-d710-4183-8f7e-3312cb98e0d4",
"_parent_id": "86076944-ba2f-4dc0-9ac0-46d8fd07b014",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ab81d624-44e0-4978-8f35-9104418e21dd",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e3fe1956-3103-438d-9bea-43b4a90152b7",
"_parent_id": "679a02f0-4e66-46d8-a192-6934bc27ec3d",
"root_parent_id": "38832e84-f9b2-4b86-b567-9b8e5b168982",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d6f18592-05a1-4488-83a5-1aadedf30a4a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "246b9203-8a95-483d-a759-8e1d7ba25154",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0a2486ea-c4a9-4cd7-99a0-69f27ea0db48",
"_parent_code": "sample string 6",
"sales_organization_id": "1e1bfd62-97ac-4ac0-a840-d66b8ed291fe",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2fc66cfe-0169-40e7-9495-eda0668bafb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "304bb19d-ec87-41ea-b60a-9b380842f152",
"db_currency_id": "902dfd95-591c-458e-b578-e3ee6c874b85",
"db_language_id": "061df0b0-25f3-4b3e-a25c-c2591bbc8a71",
"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-08-13T22:45:44.2239643+00:00"
},
"modified_dateutc": "2026-08-13T22:45:44.2239643+00:00"
},
"equipment_model_id": "9665dcd5-dae5-4f80-b4e9-6116d0749f23",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "72516928-b4b7-4da7-91c1-b5e974a43fcc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d26a3dec-3f41-42f1-8474-99c9ae6f2cf7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f7b0e8a6-c9e2-4ce6-bcc2-193ee73467dd",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9265971d-ab27-4284-9f64-24380b87ddca",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2fc66cfe-0169-40e7-9495-eda0668bafb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "304bb19d-ec87-41ea-b60a-9b380842f152",
"db_currency_id": "902dfd95-591c-458e-b578-e3ee6c874b85",
"db_language_id": "061df0b0-25f3-4b3e-a25c-c2591bbc8a71",
"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-08-13T22:45:44.2239643+00:00"
},
"modified_dateutc": "2026-08-13T22:45:44.2239643+00:00"
},
"equipment_family_id": "b9e1b479-913c-4e52-9bfa-cbc6b635bd60",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "246b9203-8a95-483d-a759-8e1d7ba25154",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0a2486ea-c4a9-4cd7-99a0-69f27ea0db48",
"_parent_code": "sample string 6",
"sales_organization_id": "1e1bfd62-97ac-4ac0-a840-d66b8ed291fe",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2fc66cfe-0169-40e7-9495-eda0668bafb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "304bb19d-ec87-41ea-b60a-9b380842f152",
"db_currency_id": "902dfd95-591c-458e-b578-e3ee6c874b85",
"db_language_id": "061df0b0-25f3-4b3e-a25c-c2591bbc8a71",
"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-08-13T22:45:44.2239643+00:00"
},
"modified_dateutc": "2026-08-13T22:45:44.2239643+00:00"
},
"date_in_production_since": "2026-08-13T22:45:44.2239643+00:00",
"date_out_of_production_since": "2026-08-13T22:45:44.2239643+00:00",
"date_end_support": "2026-08-13T22:45:44.2239643+00:00",
"sales_organization_id": "5664678e-4b90-4c9e-a4f4-384864c05210",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2fc66cfe-0169-40e7-9495-eda0668bafb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "304bb19d-ec87-41ea-b60a-9b380842f152",
"db_currency_id": "902dfd95-591c-458e-b578-e3ee6c874b85",
"db_language_id": "061df0b0-25f3-4b3e-a25c-c2591bbc8a71",
"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-08-13T22:45:44.2239643+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-08-13T22:45:44.2239643+00:00"
},
"project_status_id": "c5fdef52-afd0-4b16-9ad3-d9948d959786",
"project_status_code": "sample string 10",
"project_status": {
"id": "4aa94140-9887-4578-b2ff-6c99592a2fdf",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "cc55344a-d2d6-4777-a0fd-3ad41cbf252d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2fc66cfe-0169-40e7-9495-eda0668bafb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "304bb19d-ec87-41ea-b60a-9b380842f152",
"db_currency_id": "902dfd95-591c-458e-b578-e3ee6c874b85",
"db_language_id": "061df0b0-25f3-4b3e-a25c-c2591bbc8a71",
"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-08-13T22:45:44.2239643+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-13T22:45:44.2239643+00:00"
},
"company_id": "21dc595d-f022-4f14-9067-6f5c95591eff",
"company_code": "sample string 12",
"db_address_id": "b5d98f2a-a771-4691-b46c-ceb5021be87e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "17064e68-2ef2-4355-ab8a-71ebf6382b4c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a0934bee-5965-4628-8a13-395b61378b84",
"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-08-13T22:45:44.2239643+00:00",
"date_create": "2026-08-13T22:45:44.2239643+00:00",
"date_update": "2026-08-13T22:45:44.2239643+00:00",
"updated_by_user_id": "3520618d-22b2-4fb6-b5cb-7ab50a911e25",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-13T22:45:44.2239643+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-08-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-13T22:45:44.2239643+00:00",
"date_last_job": "2026-08-13T22:45:44.2239643+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-13T22:45:44.2239643+00:00",
"modified_dateutc": "2026-08-13T22:45:44.2239643+00:00",
"is_mobile_installation": true
},
"job_type_id": "3ce7c7c8-2ce6-4426-ae1a-7ca10a5b7b6d",
"job_type_code": "sample string 7",
"job_type": {
"id": "c3dc9433-fa6e-4912-ac5b-d65031f00708",
"name": "sample string 2",
"sales_organization_id": "cfd8fbde-b9cb-47b8-baf2-f35b7ddecd98",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-13T22:45:44.2239643+00:00",
"code": "sample string 7"
},
"job_priority_id": "6029d8a6-7d48-42bb-bdec-18965a41d169",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "496ed215-44af-433c-933f-2b39d6b31f8a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1ef66210-bfa9-4fd5-8c1f-63196073ecab",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2fc66cfe-0169-40e7-9495-eda0668bafb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "304bb19d-ec87-41ea-b60a-9b380842f152",
"db_currency_id": "902dfd95-591c-458e-b578-e3ee6c874b85",
"db_language_id": "061df0b0-25f3-4b3e-a25c-c2591bbc8a71",
"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-08-13T22:45:44.2239643+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-13T22:45:44.2239643+00:00"
},
"job_status_id": "763a74ac-d889-4abc-973e-f2410f3e3920",
"job_status_code": "sample string 11",
"db_address_id": "cea77f47-5c51-4a48-b9aa-ca83e91bc787",
"contact_id": "ad2d1e91-0581-495e-bfca-aafa8b1f1a66",
"requested_by_company_id": "c81b6dca-f258-478d-b03c-1d305a142f5f",
"requested_by_contact_id": "67c9ff52-d869-4bb7-99b2-52bae037587e",
"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-08-13T22:45:44.2239643+00:00",
"due_date": "2026-08-13T22:45:44.2239643+00:00",
"date_create": "2026-08-13T22:45:44.2239643+00:00",
"date_update": "2026-08-13T22:45:44.2239643+00:00",
"date_closed": "2026-08-13T22:45:44.2239643+00:00",
"suggested_user_id": "d9c85940-d67f-436b-8db7-8870b07f4265",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1f4faf32-2a49-4faa-bda2-c60a353159b3",
"db_language_id": "a0162685-5fbe-4ce1-8d0b-55a98bf6e3fa",
"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-08-13T22:45:44.2239643+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a5ef6341-e500-4bad-bd2b-bba9f3693a3a",
"sales_organization": {
"id": "2fc66cfe-0169-40e7-9495-eda0668bafb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "304bb19d-ec87-41ea-b60a-9b380842f152",
"db_currency_id": "902dfd95-591c-458e-b578-e3ee6c874b85",
"db_language_id": "061df0b0-25f3-4b3e-a25c-c2591bbc8a71",
"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-08-13T22:45:44.2239643+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "bc280bcf-a558-479d-b9f7-281b3a87c137",
"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": "5d8a9a83-7272-4c8e-a385-b512b5fbd60b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-13T22:45:44.2239643+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b7dbe227-d50e-4c05-877c-09e6f3a30c44"
},
"suggested_date_start": "2026-08-13T22:45:44.2239643+00:00",
"skill_id": "ad93650a-2d9f-4e33-9f21-83ae70762712",
"skill_code": "sample string 32",
"skill": {
"id": "40c45c0a-548e-4feb-afe4-5be73e4625e5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e74fc2d8-df38-4f10-a3e9-b0ff2c34d76b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2fc66cfe-0169-40e7-9495-eda0668bafb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "304bb19d-ec87-41ea-b60a-9b380842f152",
"db_currency_id": "902dfd95-591c-458e-b578-e3ee6c874b85",
"db_language_id": "061df0b0-25f3-4b3e-a25c-c2591bbc8a71",
"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-08-13T22:45:44.2239643+00:00"
},
"modified_dateutc": "2026-08-13T22:45:44.2239643+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "37c6e082-cb18-49de-afbb-dfed759e807f",
"date_reported_by_company": "2026-08-13T22:45:44.2239643+00:00",
"id2": 36,
"company_id": "1c4c8b2a-22b3-4bb5-8fed-4b8846e4425a",
"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": "a216bdd7-ff50-4bd3-8791-9323cc15a6e9",
"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-08-13T22:45:44.2239643+00:00"
},
"work_instruction_details_id": "e19e9b34-3c72-4b71-9a30-27854c0b1bc7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "807b4e15-11ef-4b88-8fef-cbf45952ea4a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "92f13dae-9f21-4e4d-b347-5d4cc1f676f7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-13T22:45:44.2239643+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": "e4ee8417-27fd-41a1-a29f-a12a83660192",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-13T22:45:44.2239643+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.