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": "d2780018-3f31-4489-9660-161725355696",
"jobs_id": "36033a3f-7ab9-40cc-b8e5-e04a21a97709",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0eb803fd-db80-488d-9842-2ab78ae42cca",
"_parent_id": "37b820cc-f19f-43e7-a72c-7cec5550df41",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2fe0db5e-4d23-40ed-87ed-097946936875",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0ec071fc-807b-46e1-9c15-f900095faf97",
"_parent_id": "158ea996-af9c-46a4-a87f-5d287c04c8a8",
"root_parent_id": "c4a478e3-de05-4757-b824-bb8a5208b826",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4324f219-cb47-4690-a36a-c658e7d276e6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ff42f336-035f-4ce2-9d9a-3782a16df5e1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5a1721ff-1d3f-4f5a-846a-6ab9d8380935",
"_parent_code": "sample string 6",
"sales_organization_id": "3fc23bd5-e6b7-4eb8-a9fd-022f80f5667a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5fa7bf79-e353-4865-9c47-8d56aed882e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3cb1bf79-a1b0-4192-8585-a67e10607281",
"db_currency_id": "70622650-f978-45e9-a118-479a0b534aaf",
"db_language_id": "6d1cd254-37d5-4bf5-b9e0-f8097134b160",
"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-07-27T21:17:57.2657784+00:00"
},
"modified_dateutc": "2026-07-27T21:17:57.2657784+00:00"
},
"equipment_model_id": "5ddef88d-79df-42b9-a2ff-4a3f057a0f5e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "eeaf4cfc-9ce7-4bc9-8c30-a81150accaf4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f153c9b4-74b5-4a7e-9ff7-be4511dfd87d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1f6cd38f-5f13-4e1f-9f16-79fa1a252d4b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c9418f92-fc15-404d-b46d-d1f1780a4407",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5fa7bf79-e353-4865-9c47-8d56aed882e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3cb1bf79-a1b0-4192-8585-a67e10607281",
"db_currency_id": "70622650-f978-45e9-a118-479a0b534aaf",
"db_language_id": "6d1cd254-37d5-4bf5-b9e0-f8097134b160",
"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-07-27T21:17:57.2657784+00:00"
},
"modified_dateutc": "2026-07-27T21:17:57.2657784+00:00"
},
"equipment_family_id": "2d49794e-3338-4834-a03e-262c7b2ddfe5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ff42f336-035f-4ce2-9d9a-3782a16df5e1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5a1721ff-1d3f-4f5a-846a-6ab9d8380935",
"_parent_code": "sample string 6",
"sales_organization_id": "3fc23bd5-e6b7-4eb8-a9fd-022f80f5667a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5fa7bf79-e353-4865-9c47-8d56aed882e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3cb1bf79-a1b0-4192-8585-a67e10607281",
"db_currency_id": "70622650-f978-45e9-a118-479a0b534aaf",
"db_language_id": "6d1cd254-37d5-4bf5-b9e0-f8097134b160",
"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-07-27T21:17:57.2657784+00:00"
},
"modified_dateutc": "2026-07-27T21:17:57.2657784+00:00"
},
"date_in_production_since": "2026-07-27T21:17:57.2657784+00:00",
"date_out_of_production_since": "2026-07-27T21:17:57.2657784+00:00",
"date_end_support": "2026-07-27T21:17:57.2657784+00:00",
"sales_organization_id": "4678bf36-d7c7-4db7-a48e-ff960dfae1b7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5fa7bf79-e353-4865-9c47-8d56aed882e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3cb1bf79-a1b0-4192-8585-a67e10607281",
"db_currency_id": "70622650-f978-45e9-a118-479a0b534aaf",
"db_language_id": "6d1cd254-37d5-4bf5-b9e0-f8097134b160",
"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-07-27T21:17:57.2657784+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-07-27T21:17:57.2657784+00:00"
},
"project_status_id": "e03afb81-5029-40be-9675-149717aa1208",
"project_status_code": "sample string 10",
"project_status": {
"id": "1e87244b-b6aa-4509-8639-476f100373d1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f477e5b1-918b-4932-ada4-df3272af9023",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5fa7bf79-e353-4865-9c47-8d56aed882e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3cb1bf79-a1b0-4192-8585-a67e10607281",
"db_currency_id": "70622650-f978-45e9-a118-479a0b534aaf",
"db_language_id": "6d1cd254-37d5-4bf5-b9e0-f8097134b160",
"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-07-27T21:17:57.2657784+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-27T21:17:57.2657784+00:00"
},
"company_id": "dfd212f8-575a-43b9-b3b8-6e2122859ac1",
"company_code": "sample string 12",
"db_address_id": "d65052db-5392-418c-911e-b35be680fcdb",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "86e16e82-b44c-4f1a-9bfe-48e0af2d771e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7e3282e8-8bbd-47f5-a65a-632eb50def87",
"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-07-27T21:17:57.2657784+00:00",
"date_create": "2026-07-27T21:17:57.2657784+00:00",
"date_update": "2026-07-27T21:17:57.2657784+00:00",
"updated_by_user_id": "d023b181-a23e-483f-b512-6882782c237c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-27T21:17:57.2657784+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-07-27T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-27T21:17:57.2657784+00:00",
"date_last_job": "2026-07-27T21:17:57.2657784+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-27T21:17:57.2657784+00:00",
"modified_dateutc": "2026-07-27T21:17:57.2657784+00:00",
"is_mobile_installation": true
},
"job_type_id": "3bb9d238-efef-4dc2-9cbc-c16af1e076ba",
"job_type_code": "sample string 7",
"job_type": {
"id": "7172013f-b9b1-47aa-b933-77fd452c2d32",
"name": "sample string 2",
"sales_organization_id": "9bf6a057-515a-4ca7-b667-0e6da9f2b618",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-27T21:17:57.2657784+00:00",
"code": "sample string 7"
},
"job_priority_id": "0d96fd56-06fd-4c6d-b8f2-bdfab40ab39c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ff6030f1-e2b5-4545-8d08-d9fa42cc2f5a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "bab7998c-c5ed-44b6-b130-c2e4a29ef961",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5fa7bf79-e353-4865-9c47-8d56aed882e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3cb1bf79-a1b0-4192-8585-a67e10607281",
"db_currency_id": "70622650-f978-45e9-a118-479a0b534aaf",
"db_language_id": "6d1cd254-37d5-4bf5-b9e0-f8097134b160",
"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-07-27T21:17:57.2657784+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-27T21:17:57.2657784+00:00"
},
"job_status_id": "376cae60-529f-4ee7-a7b6-79d7a8cb073e",
"job_status_code": "sample string 11",
"db_address_id": "1af0a2a6-1d6d-45b2-a4ee-d4d3a8365da3",
"contact_id": "f24ae0fa-42fe-4015-9b17-300ac6b91801",
"requested_by_company_id": "cf834fbe-64e9-4654-aaa0-dff73bf3b49d",
"requested_by_contact_id": "8ab3bcfa-20ad-4fab-a632-eb6e3717e3e5",
"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-07-27T21:17:57.2657784+00:00",
"due_date": "2026-07-27T21:17:57.2657784+00:00",
"date_create": "2026-07-27T21:17:57.2657784+00:00",
"date_update": "2026-07-27T21:17:57.2657784+00:00",
"date_closed": "2026-07-27T21:17:57.2657784+00:00",
"suggested_user_id": "0511c321-ac51-431e-961d-469b5503231c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "13623064-e619-42cf-a72c-2ab63b744832",
"db_language_id": "1915ca39-742e-48fe-8ead-33ef5c56c2c5",
"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-07-27T21:17:57.2657784+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "69adb33d-016f-41a5-aeeb-4a75774b971e",
"sales_organization": {
"id": "5fa7bf79-e353-4865-9c47-8d56aed882e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3cb1bf79-a1b0-4192-8585-a67e10607281",
"db_currency_id": "70622650-f978-45e9-a118-479a0b534aaf",
"db_language_id": "6d1cd254-37d5-4bf5-b9e0-f8097134b160",
"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-07-27T21:17:57.2657784+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "71ab0bc8-8240-4bb3-b2f5-e14604d2f124",
"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": "b9425668-c90d-4483-ae85-5e44b1cb41e6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-27T21:17:57.2657784+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c52993d6-d955-493d-99af-6c5bb9f101bb"
},
"suggested_date_start": "2026-07-27T21:17:57.2657784+00:00",
"skill_id": "0b0404ce-800a-4e11-9869-7a0439ebc489",
"skill_code": "sample string 32",
"skill": {
"id": "3512db90-2a92-4d87-a6c2-d5f4935d55d0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ccbfe411-f158-4dc7-a28e-cf1e5060604e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5fa7bf79-e353-4865-9c47-8d56aed882e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3cb1bf79-a1b0-4192-8585-a67e10607281",
"db_currency_id": "70622650-f978-45e9-a118-479a0b534aaf",
"db_language_id": "6d1cd254-37d5-4bf5-b9e0-f8097134b160",
"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-07-27T21:17:57.2657784+00:00"
},
"modified_dateutc": "2026-07-27T21:17:57.2657784+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "099113a3-3785-409f-8628-d3aba17d4fff",
"date_reported_by_company": "2026-07-27T21:17:57.2657784+00:00",
"id2": 36,
"company_id": "3cdd8f08-b6d1-47af-8194-064902f7a0c0",
"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": "237336da-f6f2-4fb7-b589-992f9da6b9a5",
"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-07-27T21:17:57.2657784+00:00"
},
"work_instruction_details_id": "18b82a2e-de06-4b30-967c-e063e4645865",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "54b52131-ba16-4ab3-9729-f0cbc10ae7bd",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c80ccc02-3b21-480d-8c9f-207c7e4a5f5f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-27T21:17:57.2657784+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": "f1a16745-4812-45a4-9b8e-86c9c3d197d6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-27T21:17:57.2657784+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.