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": "d3e4748e-4be2-48df-8a13-31da490b1b2a",
"jobs_id": "2976c347-2a4e-4b6a-b5f8-eb64f1bf2dbc",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c733c737-1292-4928-8ced-4a5766cc7e8b",
"_parent_id": "328cee9b-a3d8-447d-862b-3c783eab4c14",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f2a5e368-038b-4b8e-8fef-faf33e61ef6c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "366dcbec-5c78-41bf-afcf-e040d66ef606",
"_parent_id": "24b993f9-c250-467d-8ddc-aa713e06b811",
"root_parent_id": "7a6ed2f1-abae-4bc5-8239-2e7c6b91d848",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "86118f3c-11a5-400a-99cf-375f2fafa4b9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d445ae56-da4c-48d9-897f-a5fc19e68d22",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "69a0f317-379e-47f7-926c-7ac04c2a5bbf",
"_parent_code": "sample string 6",
"sales_organization_id": "44e7a345-e37b-41e5-875d-0fb7f824f22d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1c22e3a7-d7c2-415c-8bdf-f42018cbb537",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7be804a1-3300-4ec6-bf2d-becf3a169c2e",
"db_currency_id": "1447091b-cd34-4da9-82ea-0d7e44ac455f",
"db_language_id": "b0920a16-d65d-4a14-9c9b-a5dce4e75e81",
"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-03-06T09:51:02.006992+00:00"
},
"modified_dateutc": "2026-03-06T09:51:02.006992+00:00"
},
"equipment_model_id": "6731241c-4880-4bec-b7af-22a01c7c9619",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e136bee8-c357-41ac-9cc4-8f3bd5d3c7fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b90d419b-a834-4075-b700-f1b6a1da4b87",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5bfbe11e-efe6-4abe-a5d4-5aadc5a181ba",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b32ab043-eacd-44a0-8edc-3b0add8d56a0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1c22e3a7-d7c2-415c-8bdf-f42018cbb537",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7be804a1-3300-4ec6-bf2d-becf3a169c2e",
"db_currency_id": "1447091b-cd34-4da9-82ea-0d7e44ac455f",
"db_language_id": "b0920a16-d65d-4a14-9c9b-a5dce4e75e81",
"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-03-06T09:51:02.006992+00:00"
},
"modified_dateutc": "2026-03-06T09:51:02.006992+00:00"
},
"equipment_family_id": "f058083b-46f1-423a-956e-38192d08181d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d445ae56-da4c-48d9-897f-a5fc19e68d22",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "69a0f317-379e-47f7-926c-7ac04c2a5bbf",
"_parent_code": "sample string 6",
"sales_organization_id": "44e7a345-e37b-41e5-875d-0fb7f824f22d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1c22e3a7-d7c2-415c-8bdf-f42018cbb537",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7be804a1-3300-4ec6-bf2d-becf3a169c2e",
"db_currency_id": "1447091b-cd34-4da9-82ea-0d7e44ac455f",
"db_language_id": "b0920a16-d65d-4a14-9c9b-a5dce4e75e81",
"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-03-06T09:51:02.006992+00:00"
},
"modified_dateutc": "2026-03-06T09:51:02.006992+00:00"
},
"date_in_production_since": "2026-03-06T09:51:02.006992+00:00",
"date_out_of_production_since": "2026-03-06T09:51:02.006992+00:00",
"date_end_support": "2026-03-06T09:51:02.006992+00:00",
"sales_organization_id": "eb4edded-94fc-4729-a883-843b53d7457c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1c22e3a7-d7c2-415c-8bdf-f42018cbb537",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7be804a1-3300-4ec6-bf2d-becf3a169c2e",
"db_currency_id": "1447091b-cd34-4da9-82ea-0d7e44ac455f",
"db_language_id": "b0920a16-d65d-4a14-9c9b-a5dce4e75e81",
"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-03-06T09:51:02.006992+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-03-06T09:51:02.006992+00:00"
},
"project_status_id": "4e460370-cc54-4ec4-b5a5-88ec460b4571",
"project_status_code": "sample string 10",
"project_status": {
"id": "37be354c-bea7-491f-89fc-79d23e95ac16",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "67b4b094-7b1f-4640-98ee-d729683eb4fc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1c22e3a7-d7c2-415c-8bdf-f42018cbb537",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7be804a1-3300-4ec6-bf2d-becf3a169c2e",
"db_currency_id": "1447091b-cd34-4da9-82ea-0d7e44ac455f",
"db_language_id": "b0920a16-d65d-4a14-9c9b-a5dce4e75e81",
"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-03-06T09:51:02.006992+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-06T09:51:02.006992+00:00"
},
"company_id": "d4064081-e334-48e0-84eb-d56bc79169b5",
"company_code": "sample string 12",
"db_address_id": "09d3269d-3454-4d7f-96a5-8d7e086170f9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8993bfb9-9ffc-4f49-bb3a-33903beb60c3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a95e314b-ec60-4bb8-87cc-df71a90f3c0d",
"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-03-06T09:51:02.006992+00:00",
"date_create": "2026-03-06T09:51:02.006992+00:00",
"date_update": "2026-03-06T09:51:02.006992+00:00",
"updated_by_user_id": "788fb363-ac50-4c3b-93ea-db0d74810f9c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-06T09:51:02.006992+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-03-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-06T09:51:02.006992+00:00",
"date_last_job": "2026-03-06T09:51:02.006992+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-06T09:51:02.006992+00:00",
"modified_dateutc": "2026-03-06T09:51:02.006992+00:00",
"is_mobile_installation": true
},
"job_type_id": "aa32af30-b7d3-4afa-bd44-4f847811d9c2",
"job_type_code": "sample string 7",
"job_type": {
"id": "4a3024f5-d11c-47c6-8377-1d5d5b0ac504",
"name": "sample string 2",
"sales_organization_id": "f9ef0cff-24c9-46ea-9cbe-9e396d64a8b9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-06T09:51:02.006992+00:00",
"code": "sample string 7"
},
"job_priority_id": "c173e0ec-bf33-4afb-bff8-fa3bef694fa8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "55c46654-2ac6-4756-8faa-d00427999208",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "35f6d291-079e-43cd-8723-233218a534c5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1c22e3a7-d7c2-415c-8bdf-f42018cbb537",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7be804a1-3300-4ec6-bf2d-becf3a169c2e",
"db_currency_id": "1447091b-cd34-4da9-82ea-0d7e44ac455f",
"db_language_id": "b0920a16-d65d-4a14-9c9b-a5dce4e75e81",
"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-03-06T09:51:02.006992+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-06T09:51:02.006992+00:00"
},
"job_status_id": "1415b308-9126-4b3f-bd57-451f43aab523",
"job_status_code": "sample string 11",
"db_address_id": "1b63e0d6-ba63-441a-8f2b-6ad31f3e0171",
"contact_id": "ce072ed3-3d59-4239-8c8d-a2fe58eb3f5d",
"requested_by_company_id": "1ae190ed-2a6f-4334-a6fc-c417f430869f",
"requested_by_contact_id": "a507685b-47a7-4cc9-bb66-e50e6076dea4",
"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-03-06T09:51:02.006992+00:00",
"due_date": "2026-03-06T09:51:02.006992+00:00",
"date_create": "2026-03-06T09:51:02.006992+00:00",
"date_update": "2026-03-06T09:51:02.006992+00:00",
"date_closed": "2026-03-06T09:51:02.006992+00:00",
"suggested_user_id": "60ebd957-9ca8-4ca1-b000-99468dba0b27",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "cc30a2cf-010c-4920-924b-12eb2d11f763",
"db_language_id": "e9e61b58-dcea-42a6-be49-428398bbaede",
"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-03-06T09:51:02.006992+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d31c4d45-f084-4f21-8417-0dc2cecc0c03",
"sales_organization": {
"id": "1c22e3a7-d7c2-415c-8bdf-f42018cbb537",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7be804a1-3300-4ec6-bf2d-becf3a169c2e",
"db_currency_id": "1447091b-cd34-4da9-82ea-0d7e44ac455f",
"db_language_id": "b0920a16-d65d-4a14-9c9b-a5dce4e75e81",
"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-03-06T09:51:02.006992+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4066831f-0f18-499f-bdbf-f6350030e884",
"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": "51a786ce-c7bc-4798-979a-e70b93829260",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-06T09:51:02.006992+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "47cded66-927f-48f7-aa6c-4fd7f2e85464"
},
"suggested_date_start": "2026-03-06T09:51:02.006992+00:00",
"skill_id": "efb5e42c-e1d2-48ab-9879-5a4e7f183ea0",
"skill_code": "sample string 32",
"skill": {
"id": "c5bb7aa0-f6f6-497d-b0db-cfaa6826410d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d2ab48de-70dc-46ee-a7b2-bf1cc040cbc8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1c22e3a7-d7c2-415c-8bdf-f42018cbb537",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7be804a1-3300-4ec6-bf2d-becf3a169c2e",
"db_currency_id": "1447091b-cd34-4da9-82ea-0d7e44ac455f",
"db_language_id": "b0920a16-d65d-4a14-9c9b-a5dce4e75e81",
"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-03-06T09:51:02.006992+00:00"
},
"modified_dateutc": "2026-03-06T09:51:02.006992+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a1a2b387-8b36-4fd4-aedc-00d79ce00d6b",
"date_reported_by_company": "2026-03-06T09:51:02.006992+00:00",
"id2": 36,
"company_id": "face923a-ab0b-4721-b485-ac2cbed188a6",
"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": "62969aa3-b55d-4636-a8b5-837f35e83718",
"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-03-06T09:51:02.006992+00:00"
},
"work_instruction_details_id": "52ca9249-5d47-4bb6-a033-28cc3db69658",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ebd1f0ae-511d-4780-b0ae-5a1f840cbac4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d0f9037b-3ecb-4ac3-8370-252e9f35744d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-06T09:51:02.006992+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": "017096cf-d11f-4304-a293-fc7661c21118",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-06T09:51:02.006992+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.