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": "f3630fc1-2fd3-4c58-9d0d-3617b9477e88",
"jobs_id": "d3576fed-b547-41ce-81aa-0d2a100a1669",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "48be68c9-d15f-48a2-b33b-5f8a27c59783",
"_parent_id": "f7ba92a1-5a06-4359-b5c8-0889c3f7618d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c1a9f490-74d8-4d61-8cf3-b65eb954d962",
"project_reference_back_office": "sample string 5",
"project": {
"id": "fbcbca55-9b4d-4dbe-a4a6-52db4f41e687",
"_parent_id": "6cdde064-ca06-4910-a4e0-1bb8f72e8c30",
"root_parent_id": "70987d45-8b4c-4bf2-b22d-d1eb87e5258e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "cc287d34-339f-49ea-8bed-cda75a68db1b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9772af6b-610c-4856-a61d-984b598317c5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "40d31010-6d7b-4099-a6bd-89140ed91467",
"_parent_code": "sample string 6",
"sales_organization_id": "97e3ec1a-1fac-4bf4-902c-1cad3280030a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "81358ce9-dd30-46f1-a648-850a1b6b252f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc89813b-2550-433c-a41c-9187144d984b",
"db_currency_id": "065612d7-4c9d-4432-9360-9b19634a7d5b",
"db_language_id": "44e14107-278e-4a11-91d3-2d04591220d2",
"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-14T02:28:43.6391148+00:00"
},
"modified_dateutc": "2026-09-14T02:28:43.6391148+00:00"
},
"equipment_model_id": "e6f3dfe4-acf1-45d0-8541-34dcb537146a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "abfc9c44-9951-4159-b6f7-2ed48e0eb44f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4025bcfd-a3f5-46af-bb49-70e7a3240d63",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "aed5d3b0-204d-4139-83ec-cd77e681b743",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7471053d-3f79-42ea-9e3f-2e1ef8ab91ee",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "81358ce9-dd30-46f1-a648-850a1b6b252f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc89813b-2550-433c-a41c-9187144d984b",
"db_currency_id": "065612d7-4c9d-4432-9360-9b19634a7d5b",
"db_language_id": "44e14107-278e-4a11-91d3-2d04591220d2",
"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-14T02:28:43.6391148+00:00"
},
"modified_dateutc": "2026-09-14T02:28:43.6391148+00:00"
},
"equipment_family_id": "782b594b-38d7-419e-b202-f940a0a3bd45",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9772af6b-610c-4856-a61d-984b598317c5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "40d31010-6d7b-4099-a6bd-89140ed91467",
"_parent_code": "sample string 6",
"sales_organization_id": "97e3ec1a-1fac-4bf4-902c-1cad3280030a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "81358ce9-dd30-46f1-a648-850a1b6b252f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc89813b-2550-433c-a41c-9187144d984b",
"db_currency_id": "065612d7-4c9d-4432-9360-9b19634a7d5b",
"db_language_id": "44e14107-278e-4a11-91d3-2d04591220d2",
"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-14T02:28:43.6391148+00:00"
},
"modified_dateutc": "2026-09-14T02:28:43.6391148+00:00"
},
"date_in_production_since": "2026-09-14T02:28:43.6391148+00:00",
"date_out_of_production_since": "2026-09-14T02:28:43.6391148+00:00",
"date_end_support": "2026-09-14T02:28:43.6391148+00:00",
"sales_organization_id": "6131104b-09fb-4996-b651-cc12c0bfa475",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "81358ce9-dd30-46f1-a648-850a1b6b252f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc89813b-2550-433c-a41c-9187144d984b",
"db_currency_id": "065612d7-4c9d-4432-9360-9b19634a7d5b",
"db_language_id": "44e14107-278e-4a11-91d3-2d04591220d2",
"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-14T02:28:43.6391148+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-14T02:28:43.6391148+00:00"
},
"project_status_id": "aeb23af7-2abf-4379-8edf-a92215beaa7d",
"project_status_code": "sample string 10",
"project_status": {
"id": "3e3c4ca6-6001-4c30-b5b5-dafa908bfa22",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "036b95df-d50d-4486-a891-91dad6e3fe79",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "81358ce9-dd30-46f1-a648-850a1b6b252f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc89813b-2550-433c-a41c-9187144d984b",
"db_currency_id": "065612d7-4c9d-4432-9360-9b19634a7d5b",
"db_language_id": "44e14107-278e-4a11-91d3-2d04591220d2",
"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-14T02:28:43.6391148+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-14T02:28:43.6391148+00:00"
},
"company_id": "3a6c6d7d-2e2c-43c6-a15e-21138a60ae12",
"company_code": "sample string 12",
"db_address_id": "c5881b2c-e4d1-4e36-99e2-b134a61b69e9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a05305b6-bf4e-4f99-9474-8727a87a4e8b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e4336d55-6691-4a85-8c82-e1b8ac95f8e2",
"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-14T02:28:43.6391148+00:00",
"date_create": "2026-09-14T02:28:43.6391148+00:00",
"date_update": "2026-09-14T02:28:43.6391148+00:00",
"updated_by_user_id": "b333a902-9f23-4c99-bdb9-63ebe338c661",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-14T02:28:43.6391148+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-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-14T02:28:43.6391148+00:00",
"date_last_job": "2026-09-14T02:28:43.6391148+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-14T02:28:43.6391148+00:00",
"modified_dateutc": "2026-09-14T02:28:43.6391148+00:00",
"is_mobile_installation": true
},
"job_type_id": "b79f2ba8-f1e8-4749-8f00-395613ff6a57",
"job_type_code": "sample string 7",
"job_type": {
"id": "42c5541f-f2e5-4776-b386-904d081faa6e",
"name": "sample string 2",
"sales_organization_id": "746e7748-0ce0-43f9-879e-20356be9e3d8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-14T02:28:43.6391148+00:00",
"code": "sample string 7"
},
"job_priority_id": "a00cabe5-4555-4069-b799-01397f3154af",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8ae2dc6a-6cce-4141-a18f-1871b2daf097",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "90272f99-a605-481c-b3d0-83fc8f50e4eb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "81358ce9-dd30-46f1-a648-850a1b6b252f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc89813b-2550-433c-a41c-9187144d984b",
"db_currency_id": "065612d7-4c9d-4432-9360-9b19634a7d5b",
"db_language_id": "44e14107-278e-4a11-91d3-2d04591220d2",
"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-14T02:28:43.6391148+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-14T02:28:43.6391148+00:00"
},
"job_status_id": "e9f89f89-0125-4982-ad9e-190e76af551d",
"job_status_code": "sample string 11",
"db_address_id": "0b250a1d-abc5-4282-a65e-c4a0684894a3",
"contact_id": "f55d7f7e-e662-4b7a-bda0-03a547d1984d",
"requested_by_company_id": "769eac5e-6bee-4060-b7ea-f7ee198e99bf",
"requested_by_contact_id": "e102a9cd-6495-44de-b139-3070915e0045",
"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-14T02:28:43.6391148+00:00",
"due_date": "2026-09-14T02:28:43.6391148+00:00",
"date_create": "2026-09-14T02:28:43.6391148+00:00",
"date_update": "2026-09-14T02:28:43.6391148+00:00",
"date_closed": "2026-09-14T02:28:43.6391148+00:00",
"suggested_user_id": "b703a1cd-670e-4b9c-8757-19df0fb6a66b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "04d992ec-3ac1-4066-b17b-2a7798796fa2",
"db_language_id": "ee504a32-0164-4919-b4f1-b92016f13569",
"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-14T02:28:43.6391148+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6edb4d94-e9ca-4b44-825b-56b87265388e",
"sales_organization": {
"id": "81358ce9-dd30-46f1-a648-850a1b6b252f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc89813b-2550-433c-a41c-9187144d984b",
"db_currency_id": "065612d7-4c9d-4432-9360-9b19634a7d5b",
"db_language_id": "44e14107-278e-4a11-91d3-2d04591220d2",
"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-14T02:28:43.6391148+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f03df08e-e66b-421d-b37f-dd74c333a08d",
"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": "80169cd4-6728-4ad2-8693-6f5b2b54a11f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-14T02:28:43.6391148+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "83f334aa-2c66-4199-b1a9-0e2a6e46ce21"
},
"suggested_date_start": "2026-09-14T02:28:43.6391148+00:00",
"skill_id": "ca8d91ab-92ed-4b80-a92b-c7a558dae5de",
"skill_code": "sample string 32",
"skill": {
"id": "c2b598cd-2430-4f30-91b5-4ece759bbe7b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9ac36dd1-5428-44f9-8846-7698d6b39e98",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "81358ce9-dd30-46f1-a648-850a1b6b252f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc89813b-2550-433c-a41c-9187144d984b",
"db_currency_id": "065612d7-4c9d-4432-9360-9b19634a7d5b",
"db_language_id": "44e14107-278e-4a11-91d3-2d04591220d2",
"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-14T02:28:43.6391148+00:00"
},
"modified_dateutc": "2026-09-14T02:28:43.6391148+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e786f124-4693-4981-8d4b-92b8df2afb7c",
"date_reported_by_company": "2026-09-14T02:28:43.6391148+00:00",
"id2": 36,
"company_id": "607233e5-11e8-49d9-924c-f0240cec7c24",
"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": "1a7d532b-8418-4f14-894b-278a33572c0a",
"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-14T02:28:43.6391148+00:00"
},
"work_instruction_details_id": "59d997dc-ed16-4b30-8c09-83fa175a7005",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4e81354a-0384-46be-8111-00a5c346a243",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ca68d9c9-f652-42ce-b788-26be9ed07447",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-14T02:28:43.6391148+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": "a9d9583e-117a-42cf-af1e-9efc4e29f229",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-14T02:28:43.6391148+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.