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": "1afb15cd-fef4-4794-8e5e-f04ae71ff9a7",
"jobs_id": "b098ddb4-2d47-4352-92b9-0296182d6201",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "69599f12-da00-4487-89bf-a27d59277877",
"_parent_id": "d638a242-703b-4d8c-a0d0-57f9447c1ff6",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1e2b6b66-d107-4c45-9dfd-fa1f44d5729c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9155c091-ce6b-46f7-b3db-31b63526241f",
"_parent_id": "102d8934-5bfd-447b-8eef-fb9cbd34cc42",
"root_parent_id": "52efa0d7-a747-441e-b553-0f8c56fffff8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "36529d0d-d473-4441-81ec-c17cc6a9584b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3a64208b-702d-46ad-9fc7-7cefa1c4834f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1aa99dc4-ca41-4b6f-8ea5-97ab1bcf41cf",
"_parent_code": "sample string 6",
"sales_organization_id": "dec56f97-07b0-4897-9b88-a432cef683c7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "537b4478-c572-4633-9cd5-1c01f990d57f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d88ee0dc-4732-42a7-b9ac-6e3c1b5e4997",
"db_currency_id": "81266fea-1ad2-4c50-b807-af4d70fcaa58",
"db_language_id": "0566e116-4703-476c-be66-16e8976d4b62",
"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-02-05T23:31:52.3982596+00:00"
},
"modified_dateutc": "2026-02-05T23:31:52.3982596+00:00"
},
"equipment_model_id": "06304a1d-0760-4044-a8e0-391ac4f0f56d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "72681e86-8b40-4a04-ba81-e7cbb4d70013",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "078c55cb-7064-4721-8edf-855695c7374e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "df273d02-7278-4cbf-978c-5127b15ea5cc",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "be5acf6b-96f1-4a71-9418-e2fadd7e5551",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "537b4478-c572-4633-9cd5-1c01f990d57f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d88ee0dc-4732-42a7-b9ac-6e3c1b5e4997",
"db_currency_id": "81266fea-1ad2-4c50-b807-af4d70fcaa58",
"db_language_id": "0566e116-4703-476c-be66-16e8976d4b62",
"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-02-05T23:31:52.3982596+00:00"
},
"modified_dateutc": "2026-02-05T23:31:52.3982596+00:00"
},
"equipment_family_id": "92c4c09b-c0c9-425a-bf2a-6e7250e315b9",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3a64208b-702d-46ad-9fc7-7cefa1c4834f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1aa99dc4-ca41-4b6f-8ea5-97ab1bcf41cf",
"_parent_code": "sample string 6",
"sales_organization_id": "dec56f97-07b0-4897-9b88-a432cef683c7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "537b4478-c572-4633-9cd5-1c01f990d57f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d88ee0dc-4732-42a7-b9ac-6e3c1b5e4997",
"db_currency_id": "81266fea-1ad2-4c50-b807-af4d70fcaa58",
"db_language_id": "0566e116-4703-476c-be66-16e8976d4b62",
"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-02-05T23:31:52.3982596+00:00"
},
"modified_dateutc": "2026-02-05T23:31:52.3982596+00:00"
},
"date_in_production_since": "2026-02-05T23:31:52.3982596+00:00",
"date_out_of_production_since": "2026-02-05T23:31:52.3982596+00:00",
"date_end_support": "2026-02-05T23:31:52.3982596+00:00",
"sales_organization_id": "a908f463-c942-422c-a3af-3d8dbf3bcf71",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "537b4478-c572-4633-9cd5-1c01f990d57f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d88ee0dc-4732-42a7-b9ac-6e3c1b5e4997",
"db_currency_id": "81266fea-1ad2-4c50-b807-af4d70fcaa58",
"db_language_id": "0566e116-4703-476c-be66-16e8976d4b62",
"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-02-05T23:31:52.3982596+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-02-05T23:31:52.4138815+00:00"
},
"project_status_id": "0d0a2262-dff7-4b6c-8256-ec9ae4f07c4f",
"project_status_code": "sample string 10",
"project_status": {
"id": "970300a6-1757-4d43-81b5-a35bb0d43af1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "db1655a9-3695-4237-8fa3-96f249f8ef1e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "537b4478-c572-4633-9cd5-1c01f990d57f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d88ee0dc-4732-42a7-b9ac-6e3c1b5e4997",
"db_currency_id": "81266fea-1ad2-4c50-b807-af4d70fcaa58",
"db_language_id": "0566e116-4703-476c-be66-16e8976d4b62",
"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-02-05T23:31:52.3982596+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-05T23:31:52.4138815+00:00"
},
"company_id": "ca168ca0-684e-4cc9-9547-9278c0ea7150",
"company_code": "sample string 12",
"db_address_id": "b9d788ff-9f51-4e11-8d0a-4b44a8360222",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cda0ca07-f6b3-4bc3-999a-345f60c99af3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "75cfb314-509b-4b1f-a1bb-02e6e8595a9e",
"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-02-05T23:31:52.4138815+00:00",
"date_create": "2026-02-05T23:31:52.4138815+00:00",
"date_update": "2026-02-05T23:31:52.4138815+00:00",
"updated_by_user_id": "a7fbfd31-a31c-4c73-84e2-11675f0e4bae",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-05T23:31:52.4138815+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-02-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-05T23:31:52.4138815+00:00",
"date_last_job": "2026-02-05T23:31:52.4138815+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-05T23:31:52.4138815+00:00",
"modified_dateutc": "2026-02-05T23:31:52.4138815+00:00",
"is_mobile_installation": true
},
"job_type_id": "0b68827f-a0b9-477c-9f9c-417e6e86182c",
"job_type_code": "sample string 7",
"job_type": {
"id": "0d9c87e5-fe42-4dfa-93b5-68824c424ef0",
"name": "sample string 2",
"sales_organization_id": "772f27c6-bdd4-4019-aee5-a796c3862bcc",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-05T23:31:52.4138815+00:00",
"code": "sample string 7"
},
"job_priority_id": "fb2a95ac-e3f9-4291-a679-beaede7dc0dc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ab825926-83d1-48c1-8c95-e31d92427e68",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "69a5ef11-73a0-49ad-932e-ffe91dfbd6f8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "537b4478-c572-4633-9cd5-1c01f990d57f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d88ee0dc-4732-42a7-b9ac-6e3c1b5e4997",
"db_currency_id": "81266fea-1ad2-4c50-b807-af4d70fcaa58",
"db_language_id": "0566e116-4703-476c-be66-16e8976d4b62",
"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-02-05T23:31:52.3982596+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-05T23:31:52.4138815+00:00"
},
"job_status_id": "9a14deaa-7994-4903-9170-cacd4d2a35ac",
"job_status_code": "sample string 11",
"db_address_id": "23e88dcd-1f30-4ca1-ba8a-cb687e47839a",
"contact_id": "fd623104-0aa9-4a04-92da-4f8dcdcec88f",
"requested_by_company_id": "dbb04063-5c37-49a3-81ad-2bafde82858b",
"requested_by_contact_id": "dfcffd13-1ac5-4016-81ef-3a95339c64ee",
"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-02-05T23:31:52.4138815+00:00",
"due_date": "2026-02-05T23:31:52.4138815+00:00",
"date_create": "2026-02-05T23:31:52.4138815+00:00",
"date_update": "2026-02-05T23:31:52.4138815+00:00",
"date_closed": "2026-02-05T23:31:52.4138815+00:00",
"suggested_user_id": "58bc1ff7-afaa-48ac-95ae-8cf619aba73f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "61bb20c0-3ea9-4425-8c71-ee3d6217d68c",
"db_language_id": "31de03cd-110e-420c-b820-4af5dd2ede87",
"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-02-05T23:31:52.4138815+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d8ca7a63-380a-4860-9aa6-e6355c6c6093",
"sales_organization": {
"id": "537b4478-c572-4633-9cd5-1c01f990d57f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d88ee0dc-4732-42a7-b9ac-6e3c1b5e4997",
"db_currency_id": "81266fea-1ad2-4c50-b807-af4d70fcaa58",
"db_language_id": "0566e116-4703-476c-be66-16e8976d4b62",
"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-02-05T23:31:52.3982596+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "947960e0-b3e0-4171-9714-ca5f387c51b7",
"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": "f5d9f528-1983-44fb-a018-8aafe3c6eb7f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-05T23:31:52.4138815+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4a3b2357-855b-4500-99ee-d7757e953395"
},
"suggested_date_start": "2026-02-05T23:31:52.4138815+00:00",
"skill_id": "1e3ee969-2664-401e-9512-86b44c3f7fe4",
"skill_code": "sample string 32",
"skill": {
"id": "cb0459bf-7871-4ab8-ab24-67918b03052f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "af37462f-a148-4583-b87c-4d2ce66d6a40",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "537b4478-c572-4633-9cd5-1c01f990d57f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d88ee0dc-4732-42a7-b9ac-6e3c1b5e4997",
"db_currency_id": "81266fea-1ad2-4c50-b807-af4d70fcaa58",
"db_language_id": "0566e116-4703-476c-be66-16e8976d4b62",
"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-02-05T23:31:52.3982596+00:00"
},
"modified_dateutc": "2026-02-05T23:31:52.4138815+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1de3c7d1-8e69-4ab5-98a5-f0d8f7560ac4",
"date_reported_by_company": "2026-02-05T23:31:52.4138815+00:00",
"id2": 36,
"company_id": "d9412bc3-3e40-429b-8dfd-a6b376604285",
"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": "51dd0c44-8dd1-4cd9-8276-ec29629c5357",
"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-02-05T23:31:52.4138815+00:00"
},
"work_instruction_details_id": "9e908227-7b2b-4f81-81c9-7a2ca321b3db",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4b826dd0-6d74-4ed2-9df8-23aec976390e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1faf836b-d85c-46f8-af49-43e0d323faf5",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-05T23:31:52.4138815+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": "67d2dc23-f5c2-4674-98d2-78cb5a186988",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-05T23:31:52.4138815+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.