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": "13f3cb45-2514-487f-9c56-b8381c1cc449",
"jobs_id": "51ff985f-2ce6-465f-a317-c7afa9d214a6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "615f66d7-c108-4c90-9cc9-412620f9ac17",
"_parent_id": "e788cc2e-f5c3-4d36-a312-0b206d32eaf7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b1f701c4-5d93-401d-973d-c146af385e28",
"project_reference_back_office": "sample string 5",
"project": {
"id": "10622668-cfe6-4513-8aff-5304d40d8d2d",
"_parent_id": "7a3816e4-9bab-4fdc-b353-3fb862f05fdb",
"root_parent_id": "d74157d5-26b7-4888-a5f1-248bbc789258",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "00254cc1-6c95-4c71-a5f5-f98cade86f86",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d5f494bf-456c-4340-ba45-b8cc37281e0b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "71674339-f53a-45e3-b889-a9882269813c",
"_parent_code": "sample string 6",
"sales_organization_id": "99905ff0-e6af-4c76-b137-2e06a3823d24",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2c55db10-3bda-4061-ba06-05e18a7c143b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "147eb0da-c108-4ffc-89c4-07f6ce51f880",
"db_currency_id": "bb54dafa-aa21-4cab-833a-dcdd2cbf0aef",
"db_language_id": "af16dc62-9449-45e7-a411-30b0b091cf7f",
"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-10-23T09:02:23.3214271+00:00"
},
"modified_dateutc": "2026-10-23T09:02:23.3214271+00:00"
},
"equipment_model_id": "daf39cd5-36e8-4958-ba28-2de856e92c00",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ff829c45-24be-4042-8060-4c99478fb81e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "81215f06-bc36-47a4-b845-3e06b37b7251",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4bd24447-745a-4d98-aaad-34adb9df651e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0abaa590-ec3c-4aaa-80c1-868a76198edb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2c55db10-3bda-4061-ba06-05e18a7c143b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "147eb0da-c108-4ffc-89c4-07f6ce51f880",
"db_currency_id": "bb54dafa-aa21-4cab-833a-dcdd2cbf0aef",
"db_language_id": "af16dc62-9449-45e7-a411-30b0b091cf7f",
"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-10-23T09:02:23.3214271+00:00"
},
"modified_dateutc": "2026-10-23T09:02:23.3214271+00:00"
},
"equipment_family_id": "64a951d4-8de0-419f-a145-a687efc863b9",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d5f494bf-456c-4340-ba45-b8cc37281e0b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "71674339-f53a-45e3-b889-a9882269813c",
"_parent_code": "sample string 6",
"sales_organization_id": "99905ff0-e6af-4c76-b137-2e06a3823d24",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2c55db10-3bda-4061-ba06-05e18a7c143b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "147eb0da-c108-4ffc-89c4-07f6ce51f880",
"db_currency_id": "bb54dafa-aa21-4cab-833a-dcdd2cbf0aef",
"db_language_id": "af16dc62-9449-45e7-a411-30b0b091cf7f",
"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-10-23T09:02:23.3214271+00:00"
},
"modified_dateutc": "2026-10-23T09:02:23.3214271+00:00"
},
"date_in_production_since": "2026-10-23T09:02:23.3214271+00:00",
"date_out_of_production_since": "2026-10-23T09:02:23.3214271+00:00",
"date_end_support": "2026-10-23T09:02:23.3214271+00:00",
"sales_organization_id": "9f7abf92-1ab1-4800-9628-0a4e90ca0179",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2c55db10-3bda-4061-ba06-05e18a7c143b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "147eb0da-c108-4ffc-89c4-07f6ce51f880",
"db_currency_id": "bb54dafa-aa21-4cab-833a-dcdd2cbf0aef",
"db_language_id": "af16dc62-9449-45e7-a411-30b0b091cf7f",
"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-10-23T09:02:23.3214271+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-10-23T09:02:23.3214271+00:00"
},
"project_status_id": "2808163a-13c9-4a10-a574-4c58e3b29554",
"project_status_code": "sample string 10",
"project_status": {
"id": "0d2c47a1-687c-4301-bfb0-ff7c2ac6895b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "155185f8-23c6-49c4-a2e0-87a14baac0a9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2c55db10-3bda-4061-ba06-05e18a7c143b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "147eb0da-c108-4ffc-89c4-07f6ce51f880",
"db_currency_id": "bb54dafa-aa21-4cab-833a-dcdd2cbf0aef",
"db_language_id": "af16dc62-9449-45e7-a411-30b0b091cf7f",
"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-10-23T09:02:23.3214271+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-23T09:02:23.3214271+00:00"
},
"company_id": "c9ba3cf2-4f2b-4df8-9591-a134c0914182",
"company_code": "sample string 12",
"db_address_id": "05571cfd-3ccc-40cf-a6dc-f73793029da6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7cbb0bf7-27bf-46d2-815a-b51b10d2aac2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "aef1f15e-2910-44e0-a9ba-d9c8b87e7fb5",
"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-10-23T09:02:23.3214271+00:00",
"date_create": "2026-10-23T09:02:23.3214271+00:00",
"date_update": "2026-10-23T09:02:23.3214271+00:00",
"updated_by_user_id": "4e1f7a4e-cf9f-492e-9fa8-5439cfd370cb",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-23T09:02:23.3214271+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-10-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-23T09:02:23.3214271+00:00",
"date_last_job": "2026-10-23T09:02:23.3214271+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-23T09:02:23.3214271+00:00",
"modified_dateutc": "2026-10-23T09:02:23.3214271+00:00",
"is_mobile_installation": true
},
"job_type_id": "f0146e3b-973d-404c-8275-8b1755bab171",
"job_type_code": "sample string 7",
"job_type": {
"id": "fae8dd71-88ec-46c4-9e42-122b1e8dd81e",
"name": "sample string 2",
"sales_organization_id": "d5f085fb-39a9-4e43-8bd0-295349ff8b98",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-23T09:02:23.3214271+00:00",
"code": "sample string 7"
},
"job_priority_id": "8892db62-32ef-4a00-8692-40f2bf773080",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1eff7bda-c6da-4cc8-83b8-66299b219189",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "08ca4f81-358f-4e47-a412-523972815509",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2c55db10-3bda-4061-ba06-05e18a7c143b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "147eb0da-c108-4ffc-89c4-07f6ce51f880",
"db_currency_id": "bb54dafa-aa21-4cab-833a-dcdd2cbf0aef",
"db_language_id": "af16dc62-9449-45e7-a411-30b0b091cf7f",
"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-10-23T09:02:23.3214271+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-23T09:02:23.3214271+00:00"
},
"job_status_id": "cb0bd0e6-be8d-4d96-9d71-b9d34a19254c",
"job_status_code": "sample string 11",
"db_address_id": "d04f884d-6aa8-4f69-a7e4-060d1239afae",
"contact_id": "4d656262-8103-407f-9e9b-de16a0266906",
"requested_by_company_id": "73c44672-4749-4b9e-8025-71bdc8072438",
"requested_by_contact_id": "46991bb8-22e3-44ba-b916-0333d57c28d8",
"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-10-23T09:02:23.3332102+00:00",
"due_date": "2026-10-23T09:02:23.3332102+00:00",
"date_create": "2026-10-23T09:02:23.3332102+00:00",
"date_update": "2026-10-23T09:02:23.3332102+00:00",
"date_closed": "2026-10-23T09:02:23.3332102+00:00",
"suggested_user_id": "cf48abf0-ffbf-4bfd-8bba-68b60d19d031",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2359c113-7687-4299-965c-412a6bee1f21",
"db_language_id": "d746bd9e-3bd7-45e2-b74b-49e3769f0640",
"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-10-23T09:02:23.3332102+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9c6b91c4-79cf-4b3c-ad2e-86f64314a5d9",
"sales_organization": {
"id": "2c55db10-3bda-4061-ba06-05e18a7c143b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "147eb0da-c108-4ffc-89c4-07f6ce51f880",
"db_currency_id": "bb54dafa-aa21-4cab-833a-dcdd2cbf0aef",
"db_language_id": "af16dc62-9449-45e7-a411-30b0b091cf7f",
"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-10-23T09:02:23.3214271+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ee599bb6-92a6-4324-bb53-9ffcf9ccd1af",
"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": "c48f701a-f063-4bef-bd30-41caad493efe",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-23T09:02:23.3332102+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8030f3c2-2942-4e6e-bb99-9b7df736ed41"
},
"suggested_date_start": "2026-10-23T09:02:23.3332102+00:00",
"skill_id": "035f0795-8f0a-4a4d-b8ad-5450e811524f",
"skill_code": "sample string 32",
"skill": {
"id": "aaee68c9-05d8-494c-829e-8da4ecf30b57",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6019e920-7685-4e1f-9e89-fdcd43a0712d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2c55db10-3bda-4061-ba06-05e18a7c143b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "147eb0da-c108-4ffc-89c4-07f6ce51f880",
"db_currency_id": "bb54dafa-aa21-4cab-833a-dcdd2cbf0aef",
"db_language_id": "af16dc62-9449-45e7-a411-30b0b091cf7f",
"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-10-23T09:02:23.3214271+00:00"
},
"modified_dateutc": "2026-10-23T09:02:23.3332102+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b66c90d0-4390-4fe7-89ca-c2992d0dafa7",
"date_reported_by_company": "2026-10-23T09:02:23.3332102+00:00",
"id2": 36,
"company_id": "910035cb-2fb2-4533-9455-9000560ca30a",
"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": "b8b4ebb5-afce-4e84-86f1-f88adb767033",
"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-10-23T09:02:23.3332102+00:00"
},
"work_instruction_details_id": "6726e37b-1cec-493a-a771-fc2da4131431",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0693c699-6bb8-4ffb-b671-a7a66cae838a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "054896ea-8c11-4af0-bd66-a8397ada5137",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-23T09:02:23.3332102+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": "7d893300-de0f-40c7-8db6-e9b18a07da05",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-23T09:02:23.3332102+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.