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": "472aa212-01b0-43e9-9124-7a5746117607",
"jobs_id": "481e235a-c95b-42fe-a9cd-f5b113661e31",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b77535be-a978-4235-abaa-281c8127eb1b",
"_parent_id": "9b9d7b37-9c8d-45f4-8b55-fc440959960c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8a8c694d-5d34-423f-8756-f385614afcaf",
"project_reference_back_office": "sample string 5",
"project": {
"id": "56d9b01b-375d-4be4-9995-9ea202231a16",
"_parent_id": "51c5e523-ff85-4e80-826b-e3d84ba483b0",
"root_parent_id": "7298daa5-bb7f-4095-be53-e66843901edf",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "10a25139-08a6-4ec4-b717-be2555207eb3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ca4a63c9-ef99-431e-80d0-7b1f81503b84",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "827b9181-7093-43d4-96e4-456277e9af67",
"_parent_code": "sample string 6",
"sales_organization_id": "9212b48f-b4db-42ed-a3a7-8a4b6758d6ba",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cca736b4-78f4-4900-92e3-318c64037cd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1534feeb-72a0-4d61-9930-72a228864553",
"db_currency_id": "d63fd97d-7016-4d16-9255-d9acd20729a8",
"db_language_id": "6217ed1e-3c37-4f96-a559-266a0065b16a",
"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-08T07:18:36.3238912+00:00"
},
"modified_dateutc": "2025-12-08T07:18:36.3238912+00:00"
},
"equipment_model_id": "6ee11c9d-fa0d-43ed-bb34-95bdd488959e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d2088f75-2544-4f44-9abd-a4eb0a1ba880",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f90dcf4d-8512-4c7e-a3f2-a4980dd101e1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "71580200-5ebb-4225-826b-fa9cffd0b752",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2b643465-e86a-43bc-a6da-e32a206edf51",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cca736b4-78f4-4900-92e3-318c64037cd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1534feeb-72a0-4d61-9930-72a228864553",
"db_currency_id": "d63fd97d-7016-4d16-9255-d9acd20729a8",
"db_language_id": "6217ed1e-3c37-4f96-a559-266a0065b16a",
"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-08T07:18:36.3238912+00:00"
},
"modified_dateutc": "2025-12-08T07:18:36.3238912+00:00"
},
"equipment_family_id": "e882a663-bb46-4655-85f5-1401fbbbe7ee",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ca4a63c9-ef99-431e-80d0-7b1f81503b84",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "827b9181-7093-43d4-96e4-456277e9af67",
"_parent_code": "sample string 6",
"sales_organization_id": "9212b48f-b4db-42ed-a3a7-8a4b6758d6ba",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cca736b4-78f4-4900-92e3-318c64037cd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1534feeb-72a0-4d61-9930-72a228864553",
"db_currency_id": "d63fd97d-7016-4d16-9255-d9acd20729a8",
"db_language_id": "6217ed1e-3c37-4f96-a559-266a0065b16a",
"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-08T07:18:36.3238912+00:00"
},
"modified_dateutc": "2025-12-08T07:18:36.3238912+00:00"
},
"date_in_production_since": "2025-12-08T07:18:36.3238912+00:00",
"date_out_of_production_since": "2025-12-08T07:18:36.3238912+00:00",
"date_end_support": "2025-12-08T07:18:36.3238912+00:00",
"sales_organization_id": "714a3bdf-d884-43ae-ba08-0d88da499a69",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "cca736b4-78f4-4900-92e3-318c64037cd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1534feeb-72a0-4d61-9930-72a228864553",
"db_currency_id": "d63fd97d-7016-4d16-9255-d9acd20729a8",
"db_language_id": "6217ed1e-3c37-4f96-a559-266a0065b16a",
"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-08T07:18:36.3238912+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-08T07:18:36.3238912+00:00"
},
"project_status_id": "c7f14aa3-fb66-44f1-8ddf-e06ab6b1540e",
"project_status_code": "sample string 10",
"project_status": {
"id": "0bfabd49-adb9-4e1e-ba32-5ee8b94135d1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2dbcbc4c-eca8-4378-af32-2fcdcf954b7d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cca736b4-78f4-4900-92e3-318c64037cd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1534feeb-72a0-4d61-9930-72a228864553",
"db_currency_id": "d63fd97d-7016-4d16-9255-d9acd20729a8",
"db_language_id": "6217ed1e-3c37-4f96-a559-266a0065b16a",
"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-08T07:18:36.3238912+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-08T07:18:36.3238912+00:00"
},
"company_id": "d38a119c-8a55-41f8-9e23-25016836ffd0",
"company_code": "sample string 12",
"db_address_id": "bf538bbd-9d80-4ba0-9e53-2b5ebb82f327",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c5a37dc8-b923-4e4e-9760-ff7872118da9",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c0e2c814-ed6f-4e06-a6a3-22c1c91981af",
"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-08T07:18:36.3238912+00:00",
"date_create": "2025-12-08T07:18:36.3238912+00:00",
"date_update": "2025-12-08T07:18:36.3238912+00:00",
"updated_by_user_id": "5d7babd6-3868-4d3c-86b7-8854a397ed68",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-08T07:18:36.3238912+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-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-08T07:18:36.3238912+00:00",
"date_last_job": "2025-12-08T07:18:36.3238912+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-08T07:18:36.3238912+00:00",
"modified_dateutc": "2025-12-08T07:18:36.3238912+00:00",
"is_mobile_installation": true
},
"job_type_id": "f87dfffe-1dc0-4098-946a-3396497ea30d",
"job_type_code": "sample string 7",
"job_type": {
"id": "41c9de18-7888-4dd5-b338-bd4a80bcc8ef",
"name": "sample string 2",
"sales_organization_id": "7606c950-f3b2-4f9b-8f88-036209c9fb5d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-08T07:18:36.3238912+00:00",
"code": "sample string 7"
},
"job_priority_id": "7a120e0c-6cdc-491f-846d-b2a1aab9ffd6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5c271606-ffbf-4b15-8310-4057131e5261",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "328cf313-cda4-420c-88c1-d0c955f7fa3a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cca736b4-78f4-4900-92e3-318c64037cd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1534feeb-72a0-4d61-9930-72a228864553",
"db_currency_id": "d63fd97d-7016-4d16-9255-d9acd20729a8",
"db_language_id": "6217ed1e-3c37-4f96-a559-266a0065b16a",
"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-08T07:18:36.3238912+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-08T07:18:36.3238912+00:00"
},
"job_status_id": "0389af09-e5bc-4e8d-965f-63dc94517e9f",
"job_status_code": "sample string 11",
"db_address_id": "40128eaa-36f9-414d-8a26-aab602eb290b",
"contact_id": "ac9b3ab9-5c29-4e9c-8195-af91bedd95a8",
"requested_by_company_id": "6df5bae4-bec7-4631-bc39-a5751a5898ef",
"requested_by_contact_id": "1baaab66-af71-460c-be10-a276f9a566c3",
"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-08T07:18:36.3238912+00:00",
"due_date": "2025-12-08T07:18:36.3238912+00:00",
"date_create": "2025-12-08T07:18:36.3238912+00:00",
"date_update": "2025-12-08T07:18:36.3238912+00:00",
"date_closed": "2025-12-08T07:18:36.3238912+00:00",
"suggested_user_id": "4d050545-e46e-4e1f-8894-fe24307c3658",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f24c5626-cd5a-45c3-a943-f1f56d4658ed",
"db_language_id": "300aa953-4e11-4115-8551-1999c4cefd44",
"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-08T07:18:36.3238912+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "bf47a82f-e4e7-4bb3-bdb5-f7afc3e9df96",
"sales_organization": {
"id": "cca736b4-78f4-4900-92e3-318c64037cd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1534feeb-72a0-4d61-9930-72a228864553",
"db_currency_id": "d63fd97d-7016-4d16-9255-d9acd20729a8",
"db_language_id": "6217ed1e-3c37-4f96-a559-266a0065b16a",
"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-08T07:18:36.3238912+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7df3440b-0db8-456a-adc9-07ae608addbb",
"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": "b10193ad-8cc0-4c77-8525-9306399d9d02",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-08T07:18:36.3238912+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f0fb0fd9-471d-4e73-898b-53530faa963b"
},
"suggested_date_start": "2025-12-08T07:18:36.3238912+00:00",
"skill_id": "f6da3d0b-f277-4b90-8b30-6ab174493a1e",
"skill_code": "sample string 32",
"skill": {
"id": "d60d78a6-ad45-4e9e-ac4c-84d29cc6b802",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "afeda0af-45dd-4e25-bd36-ce67d030b7b1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cca736b4-78f4-4900-92e3-318c64037cd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1534feeb-72a0-4d61-9930-72a228864553",
"db_currency_id": "d63fd97d-7016-4d16-9255-d9acd20729a8",
"db_language_id": "6217ed1e-3c37-4f96-a559-266a0065b16a",
"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-08T07:18:36.3238912+00:00"
},
"modified_dateutc": "2025-12-08T07:18:36.3238912+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9748e639-b549-46ab-8710-5d2fdb2806b9",
"date_reported_by_company": "2025-12-08T07:18:36.3238912+00:00",
"id2": 36,
"company_id": "5ce55d25-365f-4a9c-811c-67ed8d543a24",
"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": "69da676b-592c-4283-b88e-ac7bfe1f8cc2",
"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-08T07:18:36.3238912+00:00"
},
"work_instruction_details_id": "c118b042-f287-47b7-abf2-74eaec7b37c7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8da9c98e-4edd-4131-ae74-5c42ba86f65a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "83550ecb-8e5a-4546-8312-998d9a09f36c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-08T07:18:36.3238912+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": "26f28c7e-8836-4416-9a2f-efb2eb79c65e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-08T07:18:36.3238912+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.