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": "57f00bd9-6e03-41fc-904a-b15096a332a7",
"jobs_id": "25c5ab8a-12f7-43a4-bf55-1d3881dba5d9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0414d50a-2343-41eb-818c-148e590898a3",
"_parent_id": "2b5d7526-03f8-4af8-a847-28a1a83927f0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c59a4c03-e2ce-48ba-9e24-d6b45f197a38",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d3c16420-1a13-4188-b645-2cf7c81f34e6",
"_parent_id": "6c70a79b-458e-4c12-84bd-b67c2bf64dcc",
"root_parent_id": "892c2228-aff3-47d1-b822-68e4e65803aa",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "bcf9acbf-c8e7-4975-8474-c01757aa6299",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "90ad64a8-4aa8-40d6-bdc2-45a999ba8107",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "01edeff0-7f7c-4fcc-a639-d218151ab637",
"_parent_code": "sample string 6",
"sales_organization_id": "a2db45dc-d15a-4ad2-9212-4a0154a41c88",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ab11b584-5b0a-4f10-bd2d-b13db6b1a9a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b3f26c8-ace1-44fa-b424-0420580e96cf",
"db_currency_id": "f5c06343-4f60-4a96-9ad6-2310ee67da8b",
"db_language_id": "f20d5039-5f48-4b95-af5e-1fad97213090",
"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-13T20:00:44.9330499+00:00"
},
"modified_dateutc": "2026-08-13T20:00:44.9330499+00:00"
},
"equipment_model_id": "495b71b3-3889-4487-9f60-6fe2f1c822cb",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "267ddaaa-7a6f-4dee-b76a-7a6eff368d11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9ef46f4f-6c59-4eaf-8b9a-635b7ed25f5e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a60d2f80-771c-4f47-8b3b-7dcc86635698",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6b3b4140-0210-4df6-9f36-fc3dd77c1432",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ab11b584-5b0a-4f10-bd2d-b13db6b1a9a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b3f26c8-ace1-44fa-b424-0420580e96cf",
"db_currency_id": "f5c06343-4f60-4a96-9ad6-2310ee67da8b",
"db_language_id": "f20d5039-5f48-4b95-af5e-1fad97213090",
"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-13T20:00:44.9330499+00:00"
},
"modified_dateutc": "2026-08-13T20:00:44.9330499+00:00"
},
"equipment_family_id": "dde95ab8-fa88-416a-9f7e-fbf1f7c5851c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "90ad64a8-4aa8-40d6-bdc2-45a999ba8107",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "01edeff0-7f7c-4fcc-a639-d218151ab637",
"_parent_code": "sample string 6",
"sales_organization_id": "a2db45dc-d15a-4ad2-9212-4a0154a41c88",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ab11b584-5b0a-4f10-bd2d-b13db6b1a9a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b3f26c8-ace1-44fa-b424-0420580e96cf",
"db_currency_id": "f5c06343-4f60-4a96-9ad6-2310ee67da8b",
"db_language_id": "f20d5039-5f48-4b95-af5e-1fad97213090",
"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-13T20:00:44.9330499+00:00"
},
"modified_dateutc": "2026-08-13T20:00:44.9330499+00:00"
},
"date_in_production_since": "2026-08-13T20:00:44.9330499+00:00",
"date_out_of_production_since": "2026-08-13T20:00:44.9330499+00:00",
"date_end_support": "2026-08-13T20:00:44.9330499+00:00",
"sales_organization_id": "85e1a624-1be8-4eb2-8c4a-b0333c9cd575",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ab11b584-5b0a-4f10-bd2d-b13db6b1a9a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b3f26c8-ace1-44fa-b424-0420580e96cf",
"db_currency_id": "f5c06343-4f60-4a96-9ad6-2310ee67da8b",
"db_language_id": "f20d5039-5f48-4b95-af5e-1fad97213090",
"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-13T20:00:44.9330499+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-13T20:00:44.9486778+00:00"
},
"project_status_id": "fd6ea2c1-a147-4655-9c14-9de4d1c5ff7a",
"project_status_code": "sample string 10",
"project_status": {
"id": "cdd60e0a-b7d4-4172-a419-099440ccdb59",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3a75ea29-5ba4-4933-a2ea-b0d0ee557fb8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ab11b584-5b0a-4f10-bd2d-b13db6b1a9a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b3f26c8-ace1-44fa-b424-0420580e96cf",
"db_currency_id": "f5c06343-4f60-4a96-9ad6-2310ee67da8b",
"db_language_id": "f20d5039-5f48-4b95-af5e-1fad97213090",
"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-13T20:00:44.9330499+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-13T20:00:44.9486778+00:00"
},
"company_id": "7eabf224-638e-4082-9630-fd1b8ffdbadf",
"company_code": "sample string 12",
"db_address_id": "1e3bc648-a622-4a89-a8c3-16bcb2efea82",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "220526c3-a4d7-4583-af08-c26a206bd184",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b0794ee8-1fd8-41bf-9a63-4a97d3cbd77d",
"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-13T20:00:44.9486778+00:00",
"date_create": "2026-08-13T20:00:44.9486778+00:00",
"date_update": "2026-08-13T20:00:44.9486778+00:00",
"updated_by_user_id": "bb3913bf-2608-4a50-b7c7-abaa89c67a93",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-13T20:00:44.9486778+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-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-13T20:00:44.9486778+00:00",
"date_last_job": "2026-08-13T20:00:44.9486778+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-13T20:00:44.9486778+00:00",
"modified_dateutc": "2026-08-13T20:00:44.9486778+00:00",
"is_mobile_installation": true
},
"job_type_id": "95807e05-8826-4399-83b9-3470dd03e5b6",
"job_type_code": "sample string 7",
"job_type": {
"id": "30fff182-0f7e-41b3-a2ab-c53ec680a53a",
"name": "sample string 2",
"sales_organization_id": "45b84f48-d4ac-47b4-9368-31d263c12f58",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-13T20:00:44.9486778+00:00",
"code": "sample string 7"
},
"job_priority_id": "35391347-11bb-441a-92ac-7f8b795f9999",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5e6e3e9e-f7a2-49d7-a3b4-c88d91c679d3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "83068f84-2956-460e-be19-255b52599e21",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ab11b584-5b0a-4f10-bd2d-b13db6b1a9a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b3f26c8-ace1-44fa-b424-0420580e96cf",
"db_currency_id": "f5c06343-4f60-4a96-9ad6-2310ee67da8b",
"db_language_id": "f20d5039-5f48-4b95-af5e-1fad97213090",
"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-13T20:00:44.9330499+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-13T20:00:44.9486778+00:00"
},
"job_status_id": "2e250cf4-acdb-4c05-a4f7-0baa219c2c88",
"job_status_code": "sample string 11",
"db_address_id": "25c8a979-087a-4aea-a92d-28c95d7a21f0",
"contact_id": "d1284e25-8c70-477d-8711-294894917ded",
"requested_by_company_id": "28399056-50ae-431f-bfba-0fc36795d686",
"requested_by_contact_id": "dc3c207c-bd22-497e-9442-75a38b6e4fb3",
"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-13T20:00:44.9486778+00:00",
"due_date": "2026-08-13T20:00:44.9486778+00:00",
"date_create": "2026-08-13T20:00:44.9486778+00:00",
"date_update": "2026-08-13T20:00:44.9486778+00:00",
"date_closed": "2026-08-13T20:00:44.9486778+00:00",
"suggested_user_id": "097cb671-c030-404e-a89b-b82949f62721",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d693da74-f7dd-47d0-bbb6-fabad36e94ff",
"db_language_id": "80e41432-757e-4141-a89d-df3e8433b090",
"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-13T20:00:44.9486778+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c6ee1ec8-2864-4f3c-8993-411bb9c75cda",
"sales_organization": {
"id": "ab11b584-5b0a-4f10-bd2d-b13db6b1a9a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b3f26c8-ace1-44fa-b424-0420580e96cf",
"db_currency_id": "f5c06343-4f60-4a96-9ad6-2310ee67da8b",
"db_language_id": "f20d5039-5f48-4b95-af5e-1fad97213090",
"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-13T20:00:44.9330499+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3338e8ad-64e5-4190-bc60-e8e21637c7fe",
"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": "386c380f-ef7b-4664-b074-21ff231f665c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-13T20:00:44.9486778+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a0f64950-64b5-415e-83ba-f098446904f7"
},
"suggested_date_start": "2026-08-13T20:00:44.9486778+00:00",
"skill_id": "6dd95f25-1576-4169-bdca-74659cf4fe9c",
"skill_code": "sample string 32",
"skill": {
"id": "6abdf2c4-97ea-4353-a2e2-19cec6827bd3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ac0f933c-a9a8-4c7a-b8c9-b7d5307ac235",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ab11b584-5b0a-4f10-bd2d-b13db6b1a9a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b3f26c8-ace1-44fa-b424-0420580e96cf",
"db_currency_id": "f5c06343-4f60-4a96-9ad6-2310ee67da8b",
"db_language_id": "f20d5039-5f48-4b95-af5e-1fad97213090",
"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-13T20:00:44.9330499+00:00"
},
"modified_dateutc": "2026-08-13T20:00:44.9486778+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5f495fa8-1f3e-4f98-ac36-1642a97c87e5",
"date_reported_by_company": "2026-08-13T20:00:44.9486778+00:00",
"id2": 36,
"company_id": "191a3c85-6c4e-41b2-ac89-b7b37dd8adfd",
"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": "288ef5a2-0e6c-4a06-ac42-1951124b8d85",
"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-13T20:00:44.9486778+00:00"
},
"work_instruction_details_id": "72b32a02-b3e8-4f36-bc85-9a46ee1a8c5b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6d2f566a-64d9-4cf1-8427-d55978bb7651",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "514809b2-55d1-4007-843c-b491dbfefb3b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-13T20:00:44.9486778+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": "a4672c48-e4c1-478f-aedc-565381f2f9dd",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-13T20:00:44.9486778+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.