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": "17e6861e-4a77-473f-a9c1-8214c5bbecc6",
"jobs_id": "0ae9400d-cdb4-49cc-85af-def6ab94c7bf",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6c1458b1-4da4-4340-8c62-3fe66962c100",
"_parent_id": "5463f123-aa09-4753-8e86-41288daf1aaa",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "78493726-4224-4efe-893a-68ce095e5d3a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "77fc2a3c-9347-4550-889f-a219d695f62f",
"_parent_id": "33498849-885c-41b7-ac37-ee16d686e05d",
"root_parent_id": "9d156e42-58d3-4716-842a-cb30496fcad5",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a4e65c60-1f90-46aa-b021-aa7f0eb87782",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3e30ae95-d290-4214-822c-6799188fe603",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "246430a8-d6c6-4804-8589-0b8c7e31d334",
"_parent_code": "sample string 6",
"sales_organization_id": "141b51f1-dc21-47a2-9ff3-9afeacecbd76",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bff1702e-7c05-4864-889a-943db13ec442",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08bb7681-606e-4492-b041-da635bf2905c",
"db_currency_id": "4673f2bc-af88-482d-b824-394902779b63",
"db_language_id": "610b49bd-5e89-45b3-ba9a-9c00e53d7079",
"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-03T22:28:10.8414891+00:00"
},
"modified_dateutc": "2025-12-03T22:28:10.8414891+00:00"
},
"equipment_model_id": "7fddedad-b02e-4b0c-bfc1-753815877bac",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5ceedce0-8fc6-4fa3-8136-48d770d9375a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5e19d936-8844-4e08-8ec1-0816b4b32110",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "80359fd7-be96-4008-8a8a-6dd5d58b62d3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "07ed718b-15db-46b5-8e4a-abcfce995d31",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bff1702e-7c05-4864-889a-943db13ec442",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08bb7681-606e-4492-b041-da635bf2905c",
"db_currency_id": "4673f2bc-af88-482d-b824-394902779b63",
"db_language_id": "610b49bd-5e89-45b3-ba9a-9c00e53d7079",
"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-03T22:28:10.8414891+00:00"
},
"modified_dateutc": "2025-12-03T22:28:10.8414891+00:00"
},
"equipment_family_id": "875db466-6777-483e-bb15-ba109d40bc57",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3e30ae95-d290-4214-822c-6799188fe603",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "246430a8-d6c6-4804-8589-0b8c7e31d334",
"_parent_code": "sample string 6",
"sales_organization_id": "141b51f1-dc21-47a2-9ff3-9afeacecbd76",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bff1702e-7c05-4864-889a-943db13ec442",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08bb7681-606e-4492-b041-da635bf2905c",
"db_currency_id": "4673f2bc-af88-482d-b824-394902779b63",
"db_language_id": "610b49bd-5e89-45b3-ba9a-9c00e53d7079",
"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-03T22:28:10.8414891+00:00"
},
"modified_dateutc": "2025-12-03T22:28:10.8414891+00:00"
},
"date_in_production_since": "2025-12-03T22:28:10.8414891+00:00",
"date_out_of_production_since": "2025-12-03T22:28:10.8414891+00:00",
"date_end_support": "2025-12-03T22:28:10.8414891+00:00",
"sales_organization_id": "74100987-a136-48d8-9af2-2aee7050f1cc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "bff1702e-7c05-4864-889a-943db13ec442",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08bb7681-606e-4492-b041-da635bf2905c",
"db_currency_id": "4673f2bc-af88-482d-b824-394902779b63",
"db_language_id": "610b49bd-5e89-45b3-ba9a-9c00e53d7079",
"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-03T22:28:10.8414891+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-03T22:28:10.8414891+00:00"
},
"project_status_id": "066240fd-c194-4ceb-ae4b-0f9659075258",
"project_status_code": "sample string 10",
"project_status": {
"id": "350ef71d-a8ee-4f97-8d4c-7b3f1582cea4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f6f8f82f-daee-40a8-8561-5e4882710d89",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bff1702e-7c05-4864-889a-943db13ec442",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08bb7681-606e-4492-b041-da635bf2905c",
"db_currency_id": "4673f2bc-af88-482d-b824-394902779b63",
"db_language_id": "610b49bd-5e89-45b3-ba9a-9c00e53d7079",
"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-03T22:28:10.8414891+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-03T22:28:10.8414891+00:00"
},
"company_id": "1af4fb1d-8c50-4db2-8e94-19efe86c0bca",
"company_code": "sample string 12",
"db_address_id": "0688356d-6124-4b8c-a22c-af78498ca374",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a14b110c-5611-4595-b13e-5b643c59e729",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7a66d721-f3bb-49ca-a4bb-a5e3aec75bfb",
"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-03T22:28:10.8414891+00:00",
"date_create": "2025-12-03T22:28:10.8414891+00:00",
"date_update": "2025-12-03T22:28:10.8414891+00:00",
"updated_by_user_id": "8623f555-6d21-4326-8209-dbfe56747ebb",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-03T22:28:10.8414891+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-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-03T22:28:10.8414891+00:00",
"date_last_job": "2025-12-03T22:28:10.8414891+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-03T22:28:10.8414891+00:00",
"modified_dateutc": "2025-12-03T22:28:10.8414891+00:00",
"is_mobile_installation": true
},
"job_type_id": "d9b06b63-7eef-4989-bd0f-bb3babe5f7fd",
"job_type_code": "sample string 7",
"job_type": {
"id": "af57708f-839a-44bd-9e82-16adbe6100e8",
"name": "sample string 2",
"sales_organization_id": "9293a9e1-a38f-4c61-b4fb-dcc27c723e73",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-03T22:28:10.8414891+00:00",
"code": "sample string 7"
},
"job_priority_id": "ee90a118-c7f4-4913-a2cb-f2581a0cc7aa",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6a2ccbe2-9f05-4ffa-b15b-d9b4378b2589",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "262533be-2819-4489-b1c8-5f20a14f778d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bff1702e-7c05-4864-889a-943db13ec442",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08bb7681-606e-4492-b041-da635bf2905c",
"db_currency_id": "4673f2bc-af88-482d-b824-394902779b63",
"db_language_id": "610b49bd-5e89-45b3-ba9a-9c00e53d7079",
"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-03T22:28:10.8414891+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-03T22:28:10.8414891+00:00"
},
"job_status_id": "ea0a249f-c052-493e-a866-3267690a45d1",
"job_status_code": "sample string 11",
"db_address_id": "bce08355-01c5-4cac-99c8-cfb8de60a979",
"contact_id": "499dd667-2c17-41a0-9936-35b5ee6a551c",
"requested_by_company_id": "9c3ec1b5-e072-496d-ac07-4dd0b98e42e2",
"requested_by_contact_id": "46a6da85-7fb5-49cd-9546-11f3b7acf947",
"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-03T22:28:10.8414891+00:00",
"due_date": "2025-12-03T22:28:10.8414891+00:00",
"date_create": "2025-12-03T22:28:10.8414891+00:00",
"date_update": "2025-12-03T22:28:10.8414891+00:00",
"date_closed": "2025-12-03T22:28:10.8414891+00:00",
"suggested_user_id": "1acb7c5e-32aa-41bc-968c-fae554e24805",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "68e3d415-7252-4b01-b607-0c0f1f796e58",
"db_language_id": "f294922b-fb5d-4793-bd1d-a496e0828ed9",
"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-03T22:28:10.8571146+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3e66c7c3-c8f1-4dad-ab8a-28197eedff98",
"sales_organization": {
"id": "bff1702e-7c05-4864-889a-943db13ec442",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08bb7681-606e-4492-b041-da635bf2905c",
"db_currency_id": "4673f2bc-af88-482d-b824-394902779b63",
"db_language_id": "610b49bd-5e89-45b3-ba9a-9c00e53d7079",
"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-03T22:28:10.8414891+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "70841dd2-3f58-48d1-8cd0-78bc5b5b2fdf",
"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": "e70a23f6-63ce-4216-a031-331ec5e63d6f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-03T22:28:10.8571146+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "22b19475-b1cb-4f19-8351-8515e12457e1"
},
"suggested_date_start": "2025-12-03T22:28:10.8571146+00:00",
"skill_id": "41eec157-7eb3-4bf2-a611-03b073accaf6",
"skill_code": "sample string 32",
"skill": {
"id": "e35b9460-3c70-45e7-a092-8b003335b0c7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7a13a2d6-1f58-4806-a367-14701b89b7f8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bff1702e-7c05-4864-889a-943db13ec442",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08bb7681-606e-4492-b041-da635bf2905c",
"db_currency_id": "4673f2bc-af88-482d-b824-394902779b63",
"db_language_id": "610b49bd-5e89-45b3-ba9a-9c00e53d7079",
"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-03T22:28:10.8414891+00:00"
},
"modified_dateutc": "2025-12-03T22:28:10.8571146+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "91c05d14-4766-4587-8483-d03dac3457e5",
"date_reported_by_company": "2025-12-03T22:28:10.8571146+00:00",
"id2": 36,
"company_id": "a13ec414-242f-4ddb-a1e9-ae11c39d7f5a",
"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": "3be2ff34-6557-4624-8504-3c892d0663d3",
"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-03T22:28:10.8571146+00:00"
},
"work_instruction_details_id": "1042be3b-d01c-4f87-b4d0-32ab1bc1c20c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e10b6ab7-7034-4116-b35c-0efc40069ef0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "925dd07a-15e3-460a-b092-60b4056b6b38",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-03T22:28:10.8571146+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": "e72b0f4f-669a-429d-b10a-f0cbf7a0c70f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-03T22:28:10.8571146+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.