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": "5c031a19-2221-4307-a934-9399f7439f21",
"jobs_id": "c6cbb136-cae7-4750-ac95-27f5dc6f20e6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ee327319-c281-43f7-a5ce-e437e9387a18",
"_parent_id": "4155c280-ed76-4c76-84e1-ed9ea959cf06",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ccc1cc87-16b6-4736-b4a8-21548b0712c2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "76bc9510-7870-48c6-b18a-9061621b449e",
"_parent_id": "5dfdf904-5b99-48c3-bd5a-e86f3561bcde",
"root_parent_id": "e28a0bca-da8c-443a-ad89-28f61c7e74c0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8bd5b9b0-172b-47db-8597-e39657fb4198",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e43226fd-01c0-4408-8c23-884f5cbea52b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2169e95e-f2a1-4a10-8300-0908fd0b78ae",
"_parent_code": "sample string 6",
"sales_organization_id": "70bbb1f6-a9b8-489e-955e-9cadb9622234",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "876bdf3c-e226-4390-8ede-b393c89283df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "15530531-5737-4ac7-b0bf-5b3bdf2cefc8",
"db_currency_id": "4e5a85b2-1725-472b-8f4d-95d7880dac2d",
"db_language_id": "edf8385d-f354-45a2-8a07-d0daca668e23",
"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-02-15T00:15:20.004959+00:00"
},
"modified_dateutc": "2026-02-15T00:15:20.004959+00:00"
},
"equipment_model_id": "aa6458e0-cfd7-47d8-9c83-cc2c56af7442",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7a5040ae-5bcf-450c-84db-82ec27331f2e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4d0c7ca2-953f-4ce5-b375-9219ffaf0c34",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "39a8f0c7-c163-45e3-b2e4-981bb037a5f2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d01cba74-c18e-496e-89c4-2db4cd907cb8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "876bdf3c-e226-4390-8ede-b393c89283df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "15530531-5737-4ac7-b0bf-5b3bdf2cefc8",
"db_currency_id": "4e5a85b2-1725-472b-8f4d-95d7880dac2d",
"db_language_id": "edf8385d-f354-45a2-8a07-d0daca668e23",
"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-02-15T00:15:20.004959+00:00"
},
"modified_dateutc": "2026-02-15T00:15:20.004959+00:00"
},
"equipment_family_id": "a9475b9e-1dc8-41a8-8d54-508c0e4bbd11",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e43226fd-01c0-4408-8c23-884f5cbea52b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2169e95e-f2a1-4a10-8300-0908fd0b78ae",
"_parent_code": "sample string 6",
"sales_organization_id": "70bbb1f6-a9b8-489e-955e-9cadb9622234",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "876bdf3c-e226-4390-8ede-b393c89283df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "15530531-5737-4ac7-b0bf-5b3bdf2cefc8",
"db_currency_id": "4e5a85b2-1725-472b-8f4d-95d7880dac2d",
"db_language_id": "edf8385d-f354-45a2-8a07-d0daca668e23",
"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-02-15T00:15:20.004959+00:00"
},
"modified_dateutc": "2026-02-15T00:15:20.004959+00:00"
},
"date_in_production_since": "2026-02-15T00:15:20.004959+00:00",
"date_out_of_production_since": "2026-02-15T00:15:20.004959+00:00",
"date_end_support": "2026-02-15T00:15:20.004959+00:00",
"sales_organization_id": "ecf79f34-cda1-493f-898b-3676ca9a091a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "876bdf3c-e226-4390-8ede-b393c89283df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "15530531-5737-4ac7-b0bf-5b3bdf2cefc8",
"db_currency_id": "4e5a85b2-1725-472b-8f4d-95d7880dac2d",
"db_language_id": "edf8385d-f354-45a2-8a07-d0daca668e23",
"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-02-15T00:15:20.004959+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-02-15T00:15:20.004959+00:00"
},
"project_status_id": "992cb322-7ff8-4a77-8996-e705a8ea7977",
"project_status_code": "sample string 10",
"project_status": {
"id": "2df2d2ad-694a-487a-8d4d-0fa2ca51b3dd",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2ad50ab4-418b-4b90-b60c-f53a3ec02ead",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "876bdf3c-e226-4390-8ede-b393c89283df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "15530531-5737-4ac7-b0bf-5b3bdf2cefc8",
"db_currency_id": "4e5a85b2-1725-472b-8f4d-95d7880dac2d",
"db_language_id": "edf8385d-f354-45a2-8a07-d0daca668e23",
"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-02-15T00:15:20.004959+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-15T00:15:20.004959+00:00"
},
"company_id": "2929a014-a9c2-4a14-a3d8-9e40ae9785e8",
"company_code": "sample string 12",
"db_address_id": "da3d52e2-4ea0-4afb-9549-6448564567f1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "283d362f-3474-452a-a516-f333cb458067",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d932ac7f-e4a7-492d-95c6-0745333cb677",
"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-02-15T00:15:20.0205829+00:00",
"date_create": "2026-02-15T00:15:20.0205829+00:00",
"date_update": "2026-02-15T00:15:20.0205829+00:00",
"updated_by_user_id": "bd62de28-65a3-4f87-ba78-d786d275cf8b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-15T00:15:20.0205829+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-02-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-15T00:15:20.0205829+00:00",
"date_last_job": "2026-02-15T00:15:20.0205829+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-15T00:15:20.0205829+00:00",
"modified_dateutc": "2026-02-15T00:15:20.0205829+00:00",
"is_mobile_installation": true
},
"job_type_id": "d46be9e8-d4e1-496d-a0c0-76c4aba732cc",
"job_type_code": "sample string 7",
"job_type": {
"id": "d1f0c9d1-6227-477f-94f1-05565d16f463",
"name": "sample string 2",
"sales_organization_id": "6a14cca4-03eb-41e2-ba28-bc275082f2a7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-15T00:15:20.0205829+00:00",
"code": "sample string 7"
},
"job_priority_id": "8014c95b-2cc1-43aa-a4fe-7ab75a8f2d6d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "60cc237b-e11a-41b6-ae9e-e4f6b4642430",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b69d57a6-e29c-4ef1-a7c4-e5112142c9b3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "876bdf3c-e226-4390-8ede-b393c89283df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "15530531-5737-4ac7-b0bf-5b3bdf2cefc8",
"db_currency_id": "4e5a85b2-1725-472b-8f4d-95d7880dac2d",
"db_language_id": "edf8385d-f354-45a2-8a07-d0daca668e23",
"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-02-15T00:15:20.004959+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-15T00:15:20.0205829+00:00"
},
"job_status_id": "2c118bd5-802f-4be9-9b3c-3677ba722d00",
"job_status_code": "sample string 11",
"db_address_id": "2793d3a4-6fd2-4686-b06a-28fca69d1dca",
"contact_id": "5d5de853-8345-4532-b09c-8ae989c42269",
"requested_by_company_id": "f28bb38f-a65e-427b-b544-c5ac927e0c88",
"requested_by_contact_id": "8da94671-57c8-4841-8bd6-be1367187e34",
"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-02-15T00:15:20.0205829+00:00",
"due_date": "2026-02-15T00:15:20.0205829+00:00",
"date_create": "2026-02-15T00:15:20.0205829+00:00",
"date_update": "2026-02-15T00:15:20.0205829+00:00",
"date_closed": "2026-02-15T00:15:20.0205829+00:00",
"suggested_user_id": "d0207bff-81b4-4bd3-b8fe-ae8579e85515",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1e155885-381d-422c-a129-e5c8d6facdbe",
"db_language_id": "99c16c3e-18b4-43ea-9d1f-27b987e92ad9",
"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-02-15T00:15:20.0205829+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "631c964d-d40b-49d2-b840-7a1753f4f824",
"sales_organization": {
"id": "876bdf3c-e226-4390-8ede-b393c89283df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "15530531-5737-4ac7-b0bf-5b3bdf2cefc8",
"db_currency_id": "4e5a85b2-1725-472b-8f4d-95d7880dac2d",
"db_language_id": "edf8385d-f354-45a2-8a07-d0daca668e23",
"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-02-15T00:15:20.004959+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f27ab3cf-cd35-4260-bab8-17a24c321c86",
"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": "ffb08a88-5db0-47ef-8b6b-7f0f6f1bc491",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-15T00:15:20.0205829+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1df74218-f0d4-4287-8e94-84e635654d2a"
},
"suggested_date_start": "2026-02-15T00:15:20.0205829+00:00",
"skill_id": "5736590c-faa7-46f3-b109-fc0ae7d5446c",
"skill_code": "sample string 32",
"skill": {
"id": "4a5cab37-ac27-4f7e-b051-2212c568c3e7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b85469ab-ae14-4971-9c1f-14c268e38cbf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "876bdf3c-e226-4390-8ede-b393c89283df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "15530531-5737-4ac7-b0bf-5b3bdf2cefc8",
"db_currency_id": "4e5a85b2-1725-472b-8f4d-95d7880dac2d",
"db_language_id": "edf8385d-f354-45a2-8a07-d0daca668e23",
"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-02-15T00:15:20.004959+00:00"
},
"modified_dateutc": "2026-02-15T00:15:20.0205829+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "186cce0e-095f-4816-bda1-15fb0290407f",
"date_reported_by_company": "2026-02-15T00:15:20.0205829+00:00",
"id2": 36,
"company_id": "8a04bf84-7861-4462-adfb-f712c2668336",
"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": "0cd3d998-0f97-4f3c-aa80-8cfb00fdcbb3",
"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-02-15T00:15:20.0205829+00:00"
},
"work_instruction_details_id": "afb01bfc-df56-4147-9043-ebb435c8dffc",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3675b2c5-6176-4385-9b6d-552510e9fdb1",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cad305af-6ea0-4b24-b8cb-570980cb463f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-15T00:15:20.0205829+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": "13151f46-5c1a-4755-9db9-aa82852e10f6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-15T00:15:20.0205829+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.