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": "f17b08bf-f476-4b13-b88e-f3c3470f47ea",
"jobs_id": "f8ff70ef-2fc1-4d07-a782-ca96c2e4176e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1109339b-7d92-4b53-9ef8-83e924b29258",
"_parent_id": "e6dfd1f9-d8e4-4960-af88-0ebf7959ddb0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8b342d82-917b-49e4-b4e9-ee4adbe34101",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3b656804-39f1-4f64-a011-e4823961e061",
"_parent_id": "e4acd06f-deb3-4b2f-bdf1-e8722cb9a850",
"root_parent_id": "1c2aeecf-c183-4afa-8656-709e7b84d255",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "cf2f996a-da79-4fc8-b03c-b572508884a3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "111bca5b-13bd-4a69-b586-e596b39239de",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "96a07e65-661c-4af7-9aaf-7cbc03159082",
"_parent_code": "sample string 6",
"sales_organization_id": "33f56c2d-0ccc-4c1c-8094-5dfceee206d8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d839c905-dbed-43e6-bb97-8c4e31b626de",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "21229402-6efc-442c-9466-8b16e88397da",
"db_currency_id": "209807b8-0a39-4b29-8245-99f79a3fd579",
"db_language_id": "3bb2fc11-77a2-4585-b016-744da8f1df9e",
"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-11-16T11:16:31.8853064+00:00"
},
"modified_dateutc": "2025-11-16T11:16:31.8853064+00:00"
},
"equipment_model_id": "ad9180cb-6d5f-4b82-a4a6-0eaccfeb435e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0da00eeb-bd79-4354-8515-3732969b3531",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4fcdf950-3693-435b-ad39-7fab95578258",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2ada299b-ebb1-4b7a-a321-30588d20ae69",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f7948302-a539-4606-8699-364d2e6b62c2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d839c905-dbed-43e6-bb97-8c4e31b626de",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "21229402-6efc-442c-9466-8b16e88397da",
"db_currency_id": "209807b8-0a39-4b29-8245-99f79a3fd579",
"db_language_id": "3bb2fc11-77a2-4585-b016-744da8f1df9e",
"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-11-16T11:16:31.8853064+00:00"
},
"modified_dateutc": "2025-11-16T11:16:31.8853064+00:00"
},
"equipment_family_id": "024563eb-bd84-48e0-9f20-1996ab9560b3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "111bca5b-13bd-4a69-b586-e596b39239de",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "96a07e65-661c-4af7-9aaf-7cbc03159082",
"_parent_code": "sample string 6",
"sales_organization_id": "33f56c2d-0ccc-4c1c-8094-5dfceee206d8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d839c905-dbed-43e6-bb97-8c4e31b626de",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "21229402-6efc-442c-9466-8b16e88397da",
"db_currency_id": "209807b8-0a39-4b29-8245-99f79a3fd579",
"db_language_id": "3bb2fc11-77a2-4585-b016-744da8f1df9e",
"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-11-16T11:16:31.8853064+00:00"
},
"modified_dateutc": "2025-11-16T11:16:31.8853064+00:00"
},
"date_in_production_since": "2025-11-16T11:16:31.8853064+00:00",
"date_out_of_production_since": "2025-11-16T11:16:31.8853064+00:00",
"date_end_support": "2025-11-16T11:16:31.8853064+00:00",
"sales_organization_id": "a321534e-0184-4a2e-a21b-c4ae106caeeb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d839c905-dbed-43e6-bb97-8c4e31b626de",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "21229402-6efc-442c-9466-8b16e88397da",
"db_currency_id": "209807b8-0a39-4b29-8245-99f79a3fd579",
"db_language_id": "3bb2fc11-77a2-4585-b016-744da8f1df9e",
"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-11-16T11:16:31.8853064+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-11-16T11:16:31.8853064+00:00"
},
"project_status_id": "305199bf-4a56-4ba5-a0c1-318278dec008",
"project_status_code": "sample string 10",
"project_status": {
"id": "333a6a21-44cc-4434-80e2-ebe296340868",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1f7eb0ba-abe9-4718-b9b4-14ac12b8e117",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d839c905-dbed-43e6-bb97-8c4e31b626de",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "21229402-6efc-442c-9466-8b16e88397da",
"db_currency_id": "209807b8-0a39-4b29-8245-99f79a3fd579",
"db_language_id": "3bb2fc11-77a2-4585-b016-744da8f1df9e",
"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-11-16T11:16:31.8853064+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-16T11:16:31.8853064+00:00"
},
"company_id": "324fbfe2-c4d5-4e2a-a552-c71b812baaea",
"company_code": "sample string 12",
"db_address_id": "b4d0cacc-c28b-419c-b8da-c5a2431e7da3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a03d78ec-f1be-40b0-9183-260ab08fbf26",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6292ddea-cd78-4bdc-a2e6-111a0e2d3acc",
"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-11-16T11:16:31.8853064+00:00",
"date_create": "2025-11-16T11:16:31.8853064+00:00",
"date_update": "2025-11-16T11:16:31.8853064+00:00",
"updated_by_user_id": "cd82ac20-8c4d-48e2-a917-9ca602fcb765",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-16T11:16:31.8853064+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-11-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-16T11:16:31.8853064+00:00",
"date_last_job": "2025-11-16T11:16:31.8853064+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-16T11:16:31.8853064+00:00",
"modified_dateutc": "2025-11-16T11:16:31.8853064+00:00",
"is_mobile_installation": true
},
"job_type_id": "3bc636fd-bd3b-4dd8-8c83-a70b21ffc0c8",
"job_type_code": "sample string 7",
"job_type": {
"id": "d87e10dc-6a19-4fd8-aa42-8e81cedb6e66",
"name": "sample string 2",
"sales_organization_id": "7152080f-ff5a-49df-b817-37df63d0d71a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-16T11:16:31.8853064+00:00",
"code": "sample string 7"
},
"job_priority_id": "ebc9ebc1-0c4b-4b4f-97b4-f36550f47c89",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "08c0e4d7-d0bd-4fa0-9bc4-530aeb41d0b8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "80fa37c4-8e34-4584-84e5-413ba61c5537",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d839c905-dbed-43e6-bb97-8c4e31b626de",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "21229402-6efc-442c-9466-8b16e88397da",
"db_currency_id": "209807b8-0a39-4b29-8245-99f79a3fd579",
"db_language_id": "3bb2fc11-77a2-4585-b016-744da8f1df9e",
"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-11-16T11:16:31.8853064+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-16T11:16:31.8853064+00:00"
},
"job_status_id": "f974eb7f-20c3-4af8-b538-85a274c4ba61",
"job_status_code": "sample string 11",
"db_address_id": "d317bb09-58fd-438c-87a7-52586eb06c25",
"contact_id": "b29b9c5a-2ca7-4055-b924-37ca91b89414",
"requested_by_company_id": "55952a97-5c82-45db-b6a4-e09b33eae5ab",
"requested_by_contact_id": "7751cc00-7dde-4043-94f0-9eba6f455817",
"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-11-16T11:16:31.8853064+00:00",
"due_date": "2025-11-16T11:16:31.8853064+00:00",
"date_create": "2025-11-16T11:16:31.8853064+00:00",
"date_update": "2025-11-16T11:16:31.8853064+00:00",
"date_closed": "2025-11-16T11:16:31.8853064+00:00",
"suggested_user_id": "74b521a6-7557-466f-8753-ad15e25b884e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fcc28bc3-fa20-4383-bb91-a1368b188f2b",
"db_language_id": "057a95c1-2eda-4a01-8f45-73fef2fea7a5",
"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-11-16T11:16:31.9009277+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "30532d44-02cf-4063-af5e-f10b430dc54b",
"sales_organization": {
"id": "d839c905-dbed-43e6-bb97-8c4e31b626de",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "21229402-6efc-442c-9466-8b16e88397da",
"db_currency_id": "209807b8-0a39-4b29-8245-99f79a3fd579",
"db_language_id": "3bb2fc11-77a2-4585-b016-744da8f1df9e",
"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-11-16T11:16:31.8853064+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "94c01afa-e6e0-4787-8a07-aa2b68c975d1",
"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": "e1b25ccb-ff8d-48f7-bd32-205213f1abe2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-16T11:16:31.9009277+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "582aaeee-302d-433c-8d39-ffefef082967"
},
"suggested_date_start": "2025-11-16T11:16:31.9009277+00:00",
"skill_id": "8e68c48a-dee7-44cd-9b71-b39b6f7a1abd",
"skill_code": "sample string 32",
"skill": {
"id": "922d4975-9ce5-4eca-8d4d-52c8ec68fc7a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d203c6e3-1390-4045-bb48-1da99e3bda9c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d839c905-dbed-43e6-bb97-8c4e31b626de",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "21229402-6efc-442c-9466-8b16e88397da",
"db_currency_id": "209807b8-0a39-4b29-8245-99f79a3fd579",
"db_language_id": "3bb2fc11-77a2-4585-b016-744da8f1df9e",
"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-11-16T11:16:31.8853064+00:00"
},
"modified_dateutc": "2025-11-16T11:16:31.9009277+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e57868ab-8f36-4a53-bba6-acd35c5fee84",
"date_reported_by_company": "2025-11-16T11:16:31.9009277+00:00",
"id2": 36,
"company_id": "c1269ac9-8a08-4440-ad8d-e2778a1832b3",
"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": "5d9cb389-44b1-44e9-acdc-107dcb29f7ff",
"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-11-16T11:16:31.9009277+00:00"
},
"work_instruction_details_id": "a739d240-8161-4fda-93c5-20e2d9a05eee",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "dc1bd49f-159f-44ef-bf15-2f61360f36a4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ba40c53b-f00c-46f1-82fe-8f25de6b1656",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-16T11:16:31.9009277+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": "ac036b6f-135b-4c4c-a90a-44664591e961",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-16T11:16:31.9009277+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.