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": "89ed9f7d-969b-4d51-b08f-49b0af5d94a3",
"jobs_id": "294b2637-42af-4c9f-9182-63290364ca87",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "94025ef8-73e2-495e-9e3c-a9566c7218f8",
"_parent_id": "9940451d-e98e-41f0-afb0-bdebb293a706",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "db70de5c-32f8-456c-af95-da2318294bd3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d489f401-87b1-4452-bf95-6bc047c21901",
"_parent_id": "aad20543-9b7d-4ae4-a050-4b11dfb4e63c",
"root_parent_id": "00fa2717-4faa-4b50-bc10-8bf3cf1f865d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c25081a6-7422-4213-bd1b-2f2dfd36be89",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e9f12d88-7cc7-4bc7-a077-84ae00a37d4a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ef2a5fe0-5989-40cc-953b-d4c163ed9cf5",
"_parent_code": "sample string 6",
"sales_organization_id": "b11766ac-23fd-4673-aa10-d63aaa9f639e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b6f859db-a05a-4cf2-ba85-4a6e40ded512",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b7f0c844-363a-4e86-ae30-af54190b2b91",
"db_currency_id": "8c0090a2-1a23-4d91-bd10-d5aba7feb8d9",
"db_language_id": "c8cb377d-061e-4128-a2f9-29d525e74ea2",
"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-01-24T04:06:46.4558764+00:00"
},
"modified_dateutc": "2026-01-24T04:06:46.4558764+00:00"
},
"equipment_model_id": "70d2d2a7-22a6-404c-8d7e-f38608c374fd",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8eaeb635-3d86-4e44-8227-f2b2c210856c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e5f1db68-db15-4a11-b663-19c58d3be94a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "91591259-2eec-4d69-9676-e74f0d6f0136",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d542c92d-e0db-4511-8ad8-717a5c7dd3fe",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b6f859db-a05a-4cf2-ba85-4a6e40ded512",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b7f0c844-363a-4e86-ae30-af54190b2b91",
"db_currency_id": "8c0090a2-1a23-4d91-bd10-d5aba7feb8d9",
"db_language_id": "c8cb377d-061e-4128-a2f9-29d525e74ea2",
"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-01-24T04:06:46.4558764+00:00"
},
"modified_dateutc": "2026-01-24T04:06:46.4558764+00:00"
},
"equipment_family_id": "b60fec8e-3f81-46fd-9779-5e55b22df01f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e9f12d88-7cc7-4bc7-a077-84ae00a37d4a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ef2a5fe0-5989-40cc-953b-d4c163ed9cf5",
"_parent_code": "sample string 6",
"sales_organization_id": "b11766ac-23fd-4673-aa10-d63aaa9f639e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b6f859db-a05a-4cf2-ba85-4a6e40ded512",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b7f0c844-363a-4e86-ae30-af54190b2b91",
"db_currency_id": "8c0090a2-1a23-4d91-bd10-d5aba7feb8d9",
"db_language_id": "c8cb377d-061e-4128-a2f9-29d525e74ea2",
"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-01-24T04:06:46.4558764+00:00"
},
"modified_dateutc": "2026-01-24T04:06:46.4558764+00:00"
},
"date_in_production_since": "2026-01-24T04:06:46.4558764+00:00",
"date_out_of_production_since": "2026-01-24T04:06:46.4558764+00:00",
"date_end_support": "2026-01-24T04:06:46.4558764+00:00",
"sales_organization_id": "26c71e20-4b40-4461-bc6d-19fceef17628",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b6f859db-a05a-4cf2-ba85-4a6e40ded512",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b7f0c844-363a-4e86-ae30-af54190b2b91",
"db_currency_id": "8c0090a2-1a23-4d91-bd10-d5aba7feb8d9",
"db_language_id": "c8cb377d-061e-4128-a2f9-29d525e74ea2",
"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-01-24T04:06:46.4558764+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-01-24T04:06:46.4558764+00:00"
},
"project_status_id": "7e544796-0823-4f08-b0a3-334e04099edc",
"project_status_code": "sample string 10",
"project_status": {
"id": "e6f706a8-86a9-4545-8e8f-945d725e4907",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1cc5d190-dd41-447a-b9cd-747876e5f962",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b6f859db-a05a-4cf2-ba85-4a6e40ded512",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b7f0c844-363a-4e86-ae30-af54190b2b91",
"db_currency_id": "8c0090a2-1a23-4d91-bd10-d5aba7feb8d9",
"db_language_id": "c8cb377d-061e-4128-a2f9-29d525e74ea2",
"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-01-24T04:06:46.4558764+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-24T04:06:46.4558764+00:00"
},
"company_id": "fcc6d9ec-9323-4afc-91eb-4c2fc38dc0a3",
"company_code": "sample string 12",
"db_address_id": "811d7694-3447-4e6d-9898-3d8b16a72055",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c3bc3dc1-7f3f-4433-a256-c16b7eea9f4a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b9b9097f-6d63-4150-af2a-bfca475f8e81",
"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-01-24T04:06:46.4558764+00:00",
"date_create": "2026-01-24T04:06:46.4558764+00:00",
"date_update": "2026-01-24T04:06:46.4683152+00:00",
"updated_by_user_id": "4bf13838-75f3-4116-b12b-b453c5f1e36e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-24T04:06:46.4683152+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-01-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-24T04:06:46.4683152+00:00",
"date_last_job": "2026-01-24T04:06:46.4683152+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-24T04:06:46.4683152+00:00",
"modified_dateutc": "2026-01-24T04:06:46.4683152+00:00",
"is_mobile_installation": true
},
"job_type_id": "1720f01d-1b01-40b9-abc0-a856c24c7340",
"job_type_code": "sample string 7",
"job_type": {
"id": "18a8e40c-f65b-40bb-b79a-b73877d791fc",
"name": "sample string 2",
"sales_organization_id": "24c6aa0f-33a0-485d-98bd-58a49cfdbddd",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-24T04:06:46.4683152+00:00",
"code": "sample string 7"
},
"job_priority_id": "d4f61f87-cecd-4e7a-ab93-4e267e8e7355",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "710f6565-8eff-4948-a90f-85be965a99d7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a98c4aa8-a2ae-42b5-a8ef-47211c951687",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b6f859db-a05a-4cf2-ba85-4a6e40ded512",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b7f0c844-363a-4e86-ae30-af54190b2b91",
"db_currency_id": "8c0090a2-1a23-4d91-bd10-d5aba7feb8d9",
"db_language_id": "c8cb377d-061e-4128-a2f9-29d525e74ea2",
"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-01-24T04:06:46.4558764+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-24T04:06:46.4683152+00:00"
},
"job_status_id": "bdf862ed-07b8-44f2-a41a-2a657a194651",
"job_status_code": "sample string 11",
"db_address_id": "f9ed406f-1337-4240-8344-a66def6bcffd",
"contact_id": "7a98ceb4-8f69-45d8-8d50-2b544e8258dc",
"requested_by_company_id": "028098ae-ef48-434a-a84a-d1603f88e196",
"requested_by_contact_id": "cdf02184-a35c-48d1-b6a2-aea199c22faa",
"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-01-24T04:06:46.4683152+00:00",
"due_date": "2026-01-24T04:06:46.4683152+00:00",
"date_create": "2026-01-24T04:06:46.4683152+00:00",
"date_update": "2026-01-24T04:06:46.4683152+00:00",
"date_closed": "2026-01-24T04:06:46.4683152+00:00",
"suggested_user_id": "4278eef9-84b8-4216-ad4f-863094506052",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "223574a4-c03e-46de-986b-01271fba6152",
"db_language_id": "2a1b41c7-d3fe-49d2-86be-5ed60408de3a",
"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-01-24T04:06:46.4683152+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "671f6198-6e46-4d32-80fe-859b5eea9ef3",
"sales_organization": {
"id": "b6f859db-a05a-4cf2-ba85-4a6e40ded512",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b7f0c844-363a-4e86-ae30-af54190b2b91",
"db_currency_id": "8c0090a2-1a23-4d91-bd10-d5aba7feb8d9",
"db_language_id": "c8cb377d-061e-4128-a2f9-29d525e74ea2",
"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-01-24T04:06:46.4558764+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2e8ed3f1-bb94-4379-a28c-8d3403295e39",
"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": "9568db2e-3bd5-450b-935f-7b77bae202e0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-24T04:06:46.4683152+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4f51ccb4-3be5-41dc-8af6-09987192ecee"
},
"suggested_date_start": "2026-01-24T04:06:46.4683152+00:00",
"skill_id": "b343714c-7862-44d0-969a-01fa673400e2",
"skill_code": "sample string 32",
"skill": {
"id": "7cfd9aa2-2522-47f1-bc1c-be12dc6e22dc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4af49d54-2809-4ac7-8cd1-b8fe2dda6da3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b6f859db-a05a-4cf2-ba85-4a6e40ded512",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b7f0c844-363a-4e86-ae30-af54190b2b91",
"db_currency_id": "8c0090a2-1a23-4d91-bd10-d5aba7feb8d9",
"db_language_id": "c8cb377d-061e-4128-a2f9-29d525e74ea2",
"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-01-24T04:06:46.4558764+00:00"
},
"modified_dateutc": "2026-01-24T04:06:46.4683152+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5b45503a-d654-41d4-807c-b714083795b9",
"date_reported_by_company": "2026-01-24T04:06:46.4683152+00:00",
"id2": 36,
"company_id": "5c9d4a3d-c51e-4b7a-8df2-04532ffdbe3a",
"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": "99c3efd9-105c-41ec-bcbe-f7e6d9e29a03",
"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-01-24T04:06:46.4683152+00:00"
},
"work_instruction_details_id": "dd40206a-971a-4921-b70c-f9afbcff4ef5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "459a3542-04b1-413e-b094-97f3f04d1629",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1a768228-2f5d-4912-89d9-1a831f40aae8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-24T04:06:46.4683152+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": "be31ba8e-108d-4f3f-93a9-2593ffca9904",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-24T04:06:46.4683152+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.