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": "941cc588-3f1a-482b-b2a9-c09325745dce",
"jobs_id": "184df16a-e649-40ff-8a01-444d79d8c55b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b50a7375-f8e2-47b1-9def-38db04314a90",
"_parent_id": "35a7a829-4cd2-49de-8a5e-930aa9b93de8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8b3b97b7-c33a-4be4-9151-35f114310028",
"project_reference_back_office": "sample string 5",
"project": {
"id": "bd10d64d-ffae-4874-acdb-30949053a5a9",
"_parent_id": "5a47dc6c-63b0-46b2-8928-f551258f804e",
"root_parent_id": "998e3ed7-b0bc-4b11-a662-c2f1ddd483b0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1114d87b-f315-4de6-85eb-ef85ee27270f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "bbc89d19-6126-4cae-8f42-8eaf2d0bc614",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bb6e8337-5af0-43fc-81ef-2e9bff5f7a6e",
"_parent_code": "sample string 6",
"sales_organization_id": "6519a451-4161-44c4-8a12-77854055b4e3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "424d7e41-37cf-4110-8d9d-1304948b80f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4151333c-44b6-48f7-9e26-cc4175ae1cb9",
"db_currency_id": "dee1325f-df7f-4f62-979b-7e54eb7ca0e6",
"db_language_id": "035b33fc-4766-4d76-9283-97c7745791e8",
"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": "2025-12-07T18:05:00.7976141+00:00"
},
"modified_dateutc": "2025-12-07T18:05:00.7976141+00:00"
},
"equipment_model_id": "fa114107-c82c-48cf-b9d8-093ca48d62e0",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2cf2e187-48b2-43b1-919b-b2d20dddaa07",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1b207073-4456-47ec-9d9a-4a86e5252a5a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d0f23fd1-5bbb-4fd0-934c-70b401df3360",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0b94e67d-cc5c-47b9-9d88-cf1b565f9808",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "424d7e41-37cf-4110-8d9d-1304948b80f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4151333c-44b6-48f7-9e26-cc4175ae1cb9",
"db_currency_id": "dee1325f-df7f-4f62-979b-7e54eb7ca0e6",
"db_language_id": "035b33fc-4766-4d76-9283-97c7745791e8",
"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": "2025-12-07T18:05:00.7976141+00:00"
},
"modified_dateutc": "2025-12-07T18:05:00.7976141+00:00"
},
"equipment_family_id": "cb65b1fe-9a11-43b4-9204-895c63498e09",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "bbc89d19-6126-4cae-8f42-8eaf2d0bc614",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bb6e8337-5af0-43fc-81ef-2e9bff5f7a6e",
"_parent_code": "sample string 6",
"sales_organization_id": "6519a451-4161-44c4-8a12-77854055b4e3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "424d7e41-37cf-4110-8d9d-1304948b80f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4151333c-44b6-48f7-9e26-cc4175ae1cb9",
"db_currency_id": "dee1325f-df7f-4f62-979b-7e54eb7ca0e6",
"db_language_id": "035b33fc-4766-4d76-9283-97c7745791e8",
"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": "2025-12-07T18:05:00.7976141+00:00"
},
"modified_dateutc": "2025-12-07T18:05:00.7976141+00:00"
},
"date_in_production_since": "2025-12-07T18:05:00.7976141+00:00",
"date_out_of_production_since": "2025-12-07T18:05:00.7976141+00:00",
"date_end_support": "2025-12-07T18:05:00.7976141+00:00",
"sales_organization_id": "29cf53d9-bfbf-4e3c-ad29-a56167184717",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "424d7e41-37cf-4110-8d9d-1304948b80f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4151333c-44b6-48f7-9e26-cc4175ae1cb9",
"db_currency_id": "dee1325f-df7f-4f62-979b-7e54eb7ca0e6",
"db_language_id": "035b33fc-4766-4d76-9283-97c7745791e8",
"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": "2025-12-07T18:05:00.7976141+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": "2025-12-07T18:05:00.7976141+00:00"
},
"project_status_id": "e39eddb9-ba93-4b95-995f-41bee6143115",
"project_status_code": "sample string 10",
"project_status": {
"id": "07fc4576-6b03-4da6-95cc-9db97f23ce30",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0a7654a2-aad2-4b26-a911-1bfd798519fe",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "424d7e41-37cf-4110-8d9d-1304948b80f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4151333c-44b6-48f7-9e26-cc4175ae1cb9",
"db_currency_id": "dee1325f-df7f-4f62-979b-7e54eb7ca0e6",
"db_language_id": "035b33fc-4766-4d76-9283-97c7745791e8",
"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": "2025-12-07T18:05:00.7976141+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-07T18:05:00.7976141+00:00"
},
"company_id": "71db79df-4b74-494d-bb19-57755d46309b",
"company_code": "sample string 12",
"db_address_id": "3bfc2ca7-9ce5-4d70-b4d8-4ad269577a23",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "42853119-ab6e-4704-8ba3-d6a2c719db80",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "26e51a77-496c-4953-9fec-5afafb33b00a",
"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": "2025-12-07T18:05:00.7976141+00:00",
"date_create": "2025-12-07T18:05:00.7976141+00:00",
"date_update": "2025-12-07T18:05:00.7976141+00:00",
"updated_by_user_id": "89caf681-673e-47ad-a5b2-1036c1c66944",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-07T18:05:00.7976141+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": "2025-12-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-07T18:05:00.7976141+00:00",
"date_last_job": "2025-12-07T18:05:00.7976141+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-07T18:05:00.7976141+00:00",
"modified_dateutc": "2025-12-07T18:05:00.7976141+00:00",
"is_mobile_installation": true
},
"job_type_id": "24babc08-1454-4bf0-a3d0-ec87eb205624",
"job_type_code": "sample string 7",
"job_type": {
"id": "f742a25f-b8ef-499b-bd37-7ff218bede23",
"name": "sample string 2",
"sales_organization_id": "9c26af69-b566-440c-a18d-5a3a72c3bdf7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-07T18:05:00.7976141+00:00",
"code": "sample string 7"
},
"job_priority_id": "eac5907b-0941-4a28-87d9-684f1587e071",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "62f35eef-c5ce-49e6-b0e4-86b8461c41a5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9c053ab0-bfe0-43ed-86d9-38c4300b2058",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "424d7e41-37cf-4110-8d9d-1304948b80f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4151333c-44b6-48f7-9e26-cc4175ae1cb9",
"db_currency_id": "dee1325f-df7f-4f62-979b-7e54eb7ca0e6",
"db_language_id": "035b33fc-4766-4d76-9283-97c7745791e8",
"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": "2025-12-07T18:05:00.7976141+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-07T18:05:00.7976141+00:00"
},
"job_status_id": "f9ae4bee-bee0-42d2-b7a1-1b579f33f811",
"job_status_code": "sample string 11",
"db_address_id": "87ba6b06-50ae-4a51-94a3-f59337d8546c",
"contact_id": "412aa3a5-6c48-4f8e-b801-f78410364447",
"requested_by_company_id": "680b4fe8-077b-49cd-a74a-23e1c928e037",
"requested_by_contact_id": "e103bf20-22d8-4a39-81ab-b809662e769a",
"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": "2025-12-07T18:05:00.7976141+00:00",
"due_date": "2025-12-07T18:05:00.7976141+00:00",
"date_create": "2025-12-07T18:05:00.7976141+00:00",
"date_update": "2025-12-07T18:05:00.7976141+00:00",
"date_closed": "2025-12-07T18:05:00.7976141+00:00",
"suggested_user_id": "15e0f050-1031-4598-91f6-24df20834833",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a8bb5673-5238-4a29-afe6-398d8eca55c9",
"db_language_id": "3594beaf-7462-469f-be01-e4958f0cf84e",
"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": "2025-12-07T18:05:00.7976141+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "da98bf84-4061-4050-a764-ccd385f7bc8f",
"sales_organization": {
"id": "424d7e41-37cf-4110-8d9d-1304948b80f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4151333c-44b6-48f7-9e26-cc4175ae1cb9",
"db_currency_id": "dee1325f-df7f-4f62-979b-7e54eb7ca0e6",
"db_language_id": "035b33fc-4766-4d76-9283-97c7745791e8",
"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": "2025-12-07T18:05:00.7976141+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4ebd3eb1-6a48-432b-a615-af87ca902ee1",
"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": "60f44b66-0c0a-4597-a10e-c5ffca8c14eb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-07T18:05:00.7976141+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e6242df2-0479-4e5b-90bb-608ebc7c9ff9"
},
"suggested_date_start": "2025-12-07T18:05:00.7976141+00:00",
"skill_id": "84419769-8435-45e8-96a2-b4d925b65a20",
"skill_code": "sample string 32",
"skill": {
"id": "d5953a8a-cf15-4836-82fb-a7b141b540db",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0f02df92-b6d4-43ff-8d4c-57f8f77dceef",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "424d7e41-37cf-4110-8d9d-1304948b80f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4151333c-44b6-48f7-9e26-cc4175ae1cb9",
"db_currency_id": "dee1325f-df7f-4f62-979b-7e54eb7ca0e6",
"db_language_id": "035b33fc-4766-4d76-9283-97c7745791e8",
"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": "2025-12-07T18:05:00.7976141+00:00"
},
"modified_dateutc": "2025-12-07T18:05:00.7976141+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ba2c65b5-ca77-4442-b5b2-abc71f2f00a2",
"date_reported_by_company": "2025-12-07T18:05:00.7976141+00:00",
"id2": 36,
"company_id": "632320da-fb71-4b83-8896-0e7453782d35",
"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": "f9ca4392-eb6b-45be-8bcf-94fafc30f979",
"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": "2025-12-07T18:05:00.7976141+00:00"
},
"work_instruction_details_id": "14ccc66e-1ce2-4a46-972f-d073b35ea0f3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1d2da6c3-b567-48b1-8c6c-f8f9534fd10a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0f851fad-9426-471c-a3e4-0316916c8399",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-07T18:05:00.7976141+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": "a211154a-bb8b-4c5a-b4b1-0e1b8523717f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-07T18:05:00.7976141+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.