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": "1410d58e-f246-46ad-b74d-373918e4d526",
"jobs_id": "f2ef05da-7e07-496f-8c04-148b895b1d87",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "80fbbb49-eaad-4cd8-8130-c15935b9d4f0",
"_parent_id": "1c15a41b-804e-4847-b190-58e6d360381c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e3ecbe2d-8cd2-4578-a072-48a802ea1698",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c58ec17b-917f-45e0-b89c-f58b0c5fa52a",
"_parent_id": "ffdfd3cf-f0ff-4db3-b7dd-ceae93d6049b",
"root_parent_id": "4a60580a-68e8-4838-9de6-9088eff16276",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "58bce74d-58c4-46f3-a888-489f3db2157a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "93087ef1-197d-4265-b526-739098ffe1f9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "49a43332-333d-4b86-a5b5-3bab37cca028",
"_parent_code": "sample string 6",
"sales_organization_id": "71b1fe22-5074-4737-bc84-b617ff79b28d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "28a55b1f-8360-44c0-9a12-bfab4febe667",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54432e45-7010-408d-9876-b87cffdd5630",
"db_currency_id": "ff49a353-d9a1-4b35-9eb3-0da66424bec0",
"db_language_id": "9f3f8839-b5ed-4a4b-96f1-6d979551d2e3",
"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-19T14:43:43.9717584+00:00"
},
"modified_dateutc": "2026-08-19T14:43:43.9717584+00:00"
},
"equipment_model_id": "0c28d581-12c2-488c-b7b4-c35c3729beb1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e3cd1a3f-e3aa-47c4-aa66-41705979404d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a070943b-63d7-4af5-a139-37396393ed24",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7aa38ca5-484f-4f18-a142-a4cb3266bf1a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "98d59edc-32ce-40ea-a8ea-b512f8b02370",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "28a55b1f-8360-44c0-9a12-bfab4febe667",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54432e45-7010-408d-9876-b87cffdd5630",
"db_currency_id": "ff49a353-d9a1-4b35-9eb3-0da66424bec0",
"db_language_id": "9f3f8839-b5ed-4a4b-96f1-6d979551d2e3",
"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-19T14:43:43.9717584+00:00"
},
"modified_dateutc": "2026-08-19T14:43:43.9717584+00:00"
},
"equipment_family_id": "f4c40fac-5ddc-4659-90d8-a551b3d9f18b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "93087ef1-197d-4265-b526-739098ffe1f9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "49a43332-333d-4b86-a5b5-3bab37cca028",
"_parent_code": "sample string 6",
"sales_organization_id": "71b1fe22-5074-4737-bc84-b617ff79b28d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "28a55b1f-8360-44c0-9a12-bfab4febe667",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54432e45-7010-408d-9876-b87cffdd5630",
"db_currency_id": "ff49a353-d9a1-4b35-9eb3-0da66424bec0",
"db_language_id": "9f3f8839-b5ed-4a4b-96f1-6d979551d2e3",
"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-19T14:43:43.9717584+00:00"
},
"modified_dateutc": "2026-08-19T14:43:43.9717584+00:00"
},
"date_in_production_since": "2026-08-19T14:43:43.9717584+00:00",
"date_out_of_production_since": "2026-08-19T14:43:43.9717584+00:00",
"date_end_support": "2026-08-19T14:43:43.9717584+00:00",
"sales_organization_id": "6d9a73e4-b418-4d17-827c-c57934594e4c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "28a55b1f-8360-44c0-9a12-bfab4febe667",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54432e45-7010-408d-9876-b87cffdd5630",
"db_currency_id": "ff49a353-d9a1-4b35-9eb3-0da66424bec0",
"db_language_id": "9f3f8839-b5ed-4a4b-96f1-6d979551d2e3",
"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-19T14:43:43.9717584+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-19T14:43:43.9717584+00:00"
},
"project_status_id": "6ac088f3-6f55-47aa-b1c0-ae4cccfde78f",
"project_status_code": "sample string 10",
"project_status": {
"id": "0ca8a78a-2add-4e89-8f7f-06880d5b644d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "18464f39-7b42-4c94-8ef6-f8f95f219841",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "28a55b1f-8360-44c0-9a12-bfab4febe667",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54432e45-7010-408d-9876-b87cffdd5630",
"db_currency_id": "ff49a353-d9a1-4b35-9eb3-0da66424bec0",
"db_language_id": "9f3f8839-b5ed-4a4b-96f1-6d979551d2e3",
"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-19T14:43:43.9717584+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-19T14:43:43.9717584+00:00"
},
"company_id": "06caca72-c51f-4c5c-9359-5d0e8ce3cf07",
"company_code": "sample string 12",
"db_address_id": "d61be9c2-cab0-4a91-9a01-c21f2cb49ad3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "830c8aa7-4583-4407-aa4c-1a257ed00f08",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5e14688b-713a-4e5c-84d1-327fae9504e0",
"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-19T14:43:43.9717584+00:00",
"date_create": "2026-08-19T14:43:43.9717584+00:00",
"date_update": "2026-08-19T14:43:43.9717584+00:00",
"updated_by_user_id": "bf4ef38d-0d44-44be-b7a0-1dfdc60d2a3f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-19T14:43:43.9717584+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-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-19T14:43:43.9717584+00:00",
"date_last_job": "2026-08-19T14:43:43.9717584+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-19T14:43:43.9717584+00:00",
"modified_dateutc": "2026-08-19T14:43:43.9717584+00:00",
"is_mobile_installation": true
},
"job_type_id": "c852d8e5-aafa-44e1-b8ec-8451207be076",
"job_type_code": "sample string 7",
"job_type": {
"id": "8d0c4cca-c2b2-4ad0-899b-15e654b31536",
"name": "sample string 2",
"sales_organization_id": "40486148-a903-4df0-92cb-1c62a36f94b8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-19T14:43:43.9717584+00:00",
"code": "sample string 7"
},
"job_priority_id": "a286814b-f89d-4ca4-862f-03b9d86fd5fa",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ba4df784-fff5-4551-82b4-bdfea5fba4fe",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9be80730-94da-4c6e-8cf8-0e1ce3df558b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "28a55b1f-8360-44c0-9a12-bfab4febe667",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54432e45-7010-408d-9876-b87cffdd5630",
"db_currency_id": "ff49a353-d9a1-4b35-9eb3-0da66424bec0",
"db_language_id": "9f3f8839-b5ed-4a4b-96f1-6d979551d2e3",
"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-19T14:43:43.9717584+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-19T14:43:43.9717584+00:00"
},
"job_status_id": "6ccbb8ee-e57a-43d3-b663-c727efaf4b79",
"job_status_code": "sample string 11",
"db_address_id": "9ce66c26-b1bb-4943-a1cc-7a714589558c",
"contact_id": "53d4c9ba-3c03-47ea-8bf1-97dd35382601",
"requested_by_company_id": "14d295da-c9c7-4d18-b5cc-d501aa42fd4e",
"requested_by_contact_id": "d6834525-1075-48a3-8ede-153dda060640",
"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-19T14:43:43.9717584+00:00",
"due_date": "2026-08-19T14:43:43.9717584+00:00",
"date_create": "2026-08-19T14:43:43.9717584+00:00",
"date_update": "2026-08-19T14:43:43.9717584+00:00",
"date_closed": "2026-08-19T14:43:43.9717584+00:00",
"suggested_user_id": "90ecdbaa-7407-4a95-a306-bd3c324cbd8d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1ef542de-51fe-4f13-92c5-b29e365dc680",
"db_language_id": "18f45aad-c3d6-48e1-bd3d-e9757415f7b1",
"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-19T14:43:43.9717584+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c1b205dc-99eb-4ad8-929f-8f84dcfad1d8",
"sales_organization": {
"id": "28a55b1f-8360-44c0-9a12-bfab4febe667",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54432e45-7010-408d-9876-b87cffdd5630",
"db_currency_id": "ff49a353-d9a1-4b35-9eb3-0da66424bec0",
"db_language_id": "9f3f8839-b5ed-4a4b-96f1-6d979551d2e3",
"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-19T14:43:43.9717584+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "58061e50-8150-4f3a-8202-de08ae8be0e2",
"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": "90e46d8b-2e22-47a9-b9b2-d31bb70f7820",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-19T14:43:43.9717584+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f526f612-b7cb-4ba9-bb01-af55ff7d9cf2"
},
"suggested_date_start": "2026-08-19T14:43:43.9717584+00:00",
"skill_id": "e8e24587-026a-4318-919b-f7931a240947",
"skill_code": "sample string 32",
"skill": {
"id": "53679b57-6955-477e-9d46-9d7afcdc9098",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e9195998-3f5f-4749-bf63-15363ff7e79b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "28a55b1f-8360-44c0-9a12-bfab4febe667",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54432e45-7010-408d-9876-b87cffdd5630",
"db_currency_id": "ff49a353-d9a1-4b35-9eb3-0da66424bec0",
"db_language_id": "9f3f8839-b5ed-4a4b-96f1-6d979551d2e3",
"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-19T14:43:43.9717584+00:00"
},
"modified_dateutc": "2026-08-19T14:43:43.9717584+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "92f35f9e-9131-4f04-981a-5970b048988e",
"date_reported_by_company": "2026-08-19T14:43:43.9717584+00:00",
"id2": 36,
"company_id": "e409c9bd-9ec1-4ec3-9b8b-95551ea1f3ff",
"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": "c0686f18-f21b-4b1f-b3f2-e43dc234af3f",
"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-19T14:43:43.9717584+00:00"
},
"work_instruction_details_id": "4c290d1b-9005-45b2-ba1a-25668f045640",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5a77ce29-1186-4a58-b364-a7be9a9038e4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "05e8d3d6-bdc7-46ef-a351-74426097b04a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-19T14:43:43.9717584+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": "f6ca500a-d9f0-46fd-9f34-07c5ea272570",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-19T14:43:43.9717584+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.