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": "b7155bba-f0be-401b-8e2c-e30d9ff5d456",
"jobs_id": "0b155418-898e-4748-a84c-2819760c3d3d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b4220528-d21d-4583-be85-d695fb4fffd8",
"_parent_id": "2810658f-37f6-4ea0-a78e-2b485f16bff6",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3dbb19a6-e5c4-4435-a5cb-654e8db563ef",
"project_reference_back_office": "sample string 5",
"project": {
"id": "60801f8f-749c-44ba-803e-6629aebea7c8",
"_parent_id": "6a16e71a-3e00-4996-9857-a15df9c296ae",
"root_parent_id": "23d133e7-dcf4-4dd7-bef8-a4dd25652169",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "bd2c765a-040b-4ae5-8f84-76711b9babd0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a7146458-6b35-4854-8619-e1d7a9edeced",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fc2c0206-bbe3-4756-85c0-f5ef5ce8040a",
"_parent_code": "sample string 6",
"sales_organization_id": "2cbe25ac-d1ea-444f-a7da-d55843d41dee",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "77835d5e-0452-4e3a-9f96-7c5fee75773e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe1420e4-277f-4f94-993b-9b3ae4dea000",
"db_currency_id": "a62e3d88-0d9f-4c1c-87c5-8c55bab416fd",
"db_language_id": "c3299b5d-9931-4154-87fd-5857b8fcead1",
"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-06-25T04:22:03.0079103+00:00"
},
"modified_dateutc": "2026-06-25T04:22:03.0079103+00:00"
},
"equipment_model_id": "d1bdd967-c2a4-4256-82d3-152996fdcf4a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ac6390cb-8629-4533-acd2-7cac875c4123",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "77106dd0-f8b4-457a-8288-1cee685274df",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f7955188-cacc-4ca5-8926-09deefaf70d0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "45380f27-5540-43a0-97cd-11fd0cca327d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "77835d5e-0452-4e3a-9f96-7c5fee75773e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe1420e4-277f-4f94-993b-9b3ae4dea000",
"db_currency_id": "a62e3d88-0d9f-4c1c-87c5-8c55bab416fd",
"db_language_id": "c3299b5d-9931-4154-87fd-5857b8fcead1",
"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-06-25T04:22:03.0079103+00:00"
},
"modified_dateutc": "2026-06-25T04:22:03.0079103+00:00"
},
"equipment_family_id": "f47ce0bd-45d7-446e-9aee-d0972e530439",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a7146458-6b35-4854-8619-e1d7a9edeced",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fc2c0206-bbe3-4756-85c0-f5ef5ce8040a",
"_parent_code": "sample string 6",
"sales_organization_id": "2cbe25ac-d1ea-444f-a7da-d55843d41dee",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "77835d5e-0452-4e3a-9f96-7c5fee75773e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe1420e4-277f-4f94-993b-9b3ae4dea000",
"db_currency_id": "a62e3d88-0d9f-4c1c-87c5-8c55bab416fd",
"db_language_id": "c3299b5d-9931-4154-87fd-5857b8fcead1",
"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-06-25T04:22:03.0079103+00:00"
},
"modified_dateutc": "2026-06-25T04:22:03.0079103+00:00"
},
"date_in_production_since": "2026-06-25T04:22:03.0079103+00:00",
"date_out_of_production_since": "2026-06-25T04:22:03.0079103+00:00",
"date_end_support": "2026-06-25T04:22:03.0079103+00:00",
"sales_organization_id": "c7f50072-d33c-47fc-b9a6-032ad65c9272",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "77835d5e-0452-4e3a-9f96-7c5fee75773e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe1420e4-277f-4f94-993b-9b3ae4dea000",
"db_currency_id": "a62e3d88-0d9f-4c1c-87c5-8c55bab416fd",
"db_language_id": "c3299b5d-9931-4154-87fd-5857b8fcead1",
"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-06-25T04:22:03.0079103+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-06-25T04:22:03.023538+00:00"
},
"project_status_id": "e3fae2eb-8407-4600-8e8f-dff28eba722e",
"project_status_code": "sample string 10",
"project_status": {
"id": "3e85039f-2782-4282-91e3-9c71b7d16a3d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8544cb69-0fbf-42e9-8793-8667c2a5b698",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "77835d5e-0452-4e3a-9f96-7c5fee75773e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe1420e4-277f-4f94-993b-9b3ae4dea000",
"db_currency_id": "a62e3d88-0d9f-4c1c-87c5-8c55bab416fd",
"db_language_id": "c3299b5d-9931-4154-87fd-5857b8fcead1",
"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-06-25T04:22:03.0079103+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-25T04:22:03.023538+00:00"
},
"company_id": "2b2f75a4-b389-4b55-8a47-cf02d8b82d41",
"company_code": "sample string 12",
"db_address_id": "f8727a25-72b3-468a-acd3-f51efc87054e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "18c0ca08-402e-4c10-bef4-743eb1324080",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2aefbba2-4d26-460c-88a4-f06eaf7fe9ec",
"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-06-25T04:22:03.023538+00:00",
"date_create": "2026-06-25T04:22:03.023538+00:00",
"date_update": "2026-06-25T04:22:03.023538+00:00",
"updated_by_user_id": "efea6723-6a16-48e2-8e58-b20951ce99b1",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-25T04:22:03.023538+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-06-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-25T04:22:03.023538+00:00",
"date_last_job": "2026-06-25T04:22:03.023538+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-25T04:22:03.023538+00:00",
"modified_dateutc": "2026-06-25T04:22:03.023538+00:00",
"is_mobile_installation": true
},
"job_type_id": "7b3cee76-6eab-46b3-ae39-0dfa27f1e437",
"job_type_code": "sample string 7",
"job_type": {
"id": "db993f3c-6cec-4512-a158-be712e4ec13a",
"name": "sample string 2",
"sales_organization_id": "44e75cec-950d-4e79-b6b0-7adc990efe40",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-25T04:22:03.023538+00:00",
"code": "sample string 7"
},
"job_priority_id": "7098c946-a595-4651-a16c-fed7350db891",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c8ca5fdd-7055-4c2e-ac76-e71b921c710d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e5186af3-db16-4345-9283-6417f3d66639",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "77835d5e-0452-4e3a-9f96-7c5fee75773e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe1420e4-277f-4f94-993b-9b3ae4dea000",
"db_currency_id": "a62e3d88-0d9f-4c1c-87c5-8c55bab416fd",
"db_language_id": "c3299b5d-9931-4154-87fd-5857b8fcead1",
"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-06-25T04:22:03.0079103+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-25T04:22:03.023538+00:00"
},
"job_status_id": "f56f018e-1bac-45d7-86df-82c1cf2bb1cb",
"job_status_code": "sample string 11",
"db_address_id": "84cf0db6-e684-4173-b822-eb3197d67c96",
"contact_id": "df404bb3-9fa0-4a11-9ab6-c676e8fbe5e9",
"requested_by_company_id": "65cb07a9-1b8f-4fd8-b174-296be0b13dfb",
"requested_by_contact_id": "13b9296a-411a-4d51-9c1b-1259bf33084a",
"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-06-25T04:22:03.023538+00:00",
"due_date": "2026-06-25T04:22:03.023538+00:00",
"date_create": "2026-06-25T04:22:03.023538+00:00",
"date_update": "2026-06-25T04:22:03.023538+00:00",
"date_closed": "2026-06-25T04:22:03.023538+00:00",
"suggested_user_id": "626889a4-97b5-4cd7-96b7-b971c62019f2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d8632aa3-c579-4015-9ec4-ff7ef1a41c5a",
"db_language_id": "a7e26d40-d36a-48f2-ad58-e3a2195df2f3",
"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-06-25T04:22:03.023538+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "46a9ec00-67b9-4d8d-b17b-1732dcc86bb7",
"sales_organization": {
"id": "77835d5e-0452-4e3a-9f96-7c5fee75773e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe1420e4-277f-4f94-993b-9b3ae4dea000",
"db_currency_id": "a62e3d88-0d9f-4c1c-87c5-8c55bab416fd",
"db_language_id": "c3299b5d-9931-4154-87fd-5857b8fcead1",
"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-06-25T04:22:03.0079103+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6cc3b666-9037-44b8-81c4-077581246b7d",
"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": "e059dd5f-abb0-45ac-bd45-49b9037d0958",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-25T04:22:03.023538+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2e3793e9-8d18-402a-9282-68267bf96c6b"
},
"suggested_date_start": "2026-06-25T04:22:03.023538+00:00",
"skill_id": "00d99698-97a4-4ba2-8ef4-85620ea147c6",
"skill_code": "sample string 32",
"skill": {
"id": "2509a9fa-9d1c-4ce1-813b-c10fc565fa27",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6c95c318-e7bc-41dd-92af-0f5ad9996544",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "77835d5e-0452-4e3a-9f96-7c5fee75773e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe1420e4-277f-4f94-993b-9b3ae4dea000",
"db_currency_id": "a62e3d88-0d9f-4c1c-87c5-8c55bab416fd",
"db_language_id": "c3299b5d-9931-4154-87fd-5857b8fcead1",
"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-06-25T04:22:03.0079103+00:00"
},
"modified_dateutc": "2026-06-25T04:22:03.023538+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7e0f5ea0-e414-457b-bf7a-e381551114d7",
"date_reported_by_company": "2026-06-25T04:22:03.023538+00:00",
"id2": 36,
"company_id": "59db992d-53fa-4a1c-9653-b6f8b46cb628",
"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": "e2ebf351-4d65-446f-a90c-a9749294ea39",
"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-06-25T04:22:03.0391614+00:00"
},
"work_instruction_details_id": "472f318a-8429-4f00-9ead-2158bec56ea6",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9ba90fd1-bd10-4bac-868f-3dd464454a08",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "02d49303-0987-4b4d-bdbc-4cc5b0ad02d0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-25T04:22:03.0391614+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": "b7ab7fc9-18fc-4a2a-b088-81d4a3cef41e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-25T04:22:03.0391614+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.