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": "415d298c-79fb-4baa-a6da-251b62e7e7e5",
"jobs_id": "8d9a4b65-c8ca-4e56-954a-a6a7c43a1598",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "902c94c6-fd77-40c4-a14c-2e76efe7257c",
"_parent_id": "08c223fa-3241-454d-a470-ff161c5eae10",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c825ecf0-21e8-46a5-9f48-e2cf394ffe46",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1a9f375c-9fa4-4130-8b86-fa1fdb39c8f4",
"_parent_id": "4887f94d-e4ad-4b8d-a5d1-9f34632560f4",
"root_parent_id": "f5389c28-1d89-4fdf-9844-2f519d67fff8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fb73f032-5198-4652-b1b1-df4f1d8c686a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0ca11f13-f922-4d79-89c7-fada7abc8684",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1d9de7f3-7b8f-4de4-8a85-686ce9b654ea",
"_parent_code": "sample string 6",
"sales_organization_id": "c71b0803-69c3-498b-94f3-5f679e9845e1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "858fb45c-6f7f-492c-ae81-11a0aef6b6df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "19d7ea56-a13d-4853-865b-adac0e317a4a",
"db_currency_id": "a62fda9a-070f-4200-a4e1-a6a03cf2e987",
"db_language_id": "8fd7386e-a75e-434b-9917-1f2c5c4d1c25",
"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-04-07T05:33:50.2543687+00:00"
},
"modified_dateutc": "2026-04-07T05:33:50.2543687+00:00"
},
"equipment_model_id": "679fdb55-9f5a-4bbb-84d8-aa01a0c72f28",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a4cd5965-df72-4037-a6b5-ce77b1e97451",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b02c92cb-e31a-4365-9cef-80cdcf3aefff",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6eec63a5-d3cc-42ba-aedc-cada3fb1195b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5a708eff-8987-4f7b-ba05-11486ebf6be3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "858fb45c-6f7f-492c-ae81-11a0aef6b6df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "19d7ea56-a13d-4853-865b-adac0e317a4a",
"db_currency_id": "a62fda9a-070f-4200-a4e1-a6a03cf2e987",
"db_language_id": "8fd7386e-a75e-434b-9917-1f2c5c4d1c25",
"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-04-07T05:33:50.2543687+00:00"
},
"modified_dateutc": "2026-04-07T05:33:50.2543687+00:00"
},
"equipment_family_id": "96b709a3-0f1b-4f5c-8fb9-932d0511f51e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0ca11f13-f922-4d79-89c7-fada7abc8684",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1d9de7f3-7b8f-4de4-8a85-686ce9b654ea",
"_parent_code": "sample string 6",
"sales_organization_id": "c71b0803-69c3-498b-94f3-5f679e9845e1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "858fb45c-6f7f-492c-ae81-11a0aef6b6df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "19d7ea56-a13d-4853-865b-adac0e317a4a",
"db_currency_id": "a62fda9a-070f-4200-a4e1-a6a03cf2e987",
"db_language_id": "8fd7386e-a75e-434b-9917-1f2c5c4d1c25",
"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-04-07T05:33:50.2543687+00:00"
},
"modified_dateutc": "2026-04-07T05:33:50.2543687+00:00"
},
"date_in_production_since": "2026-04-07T05:33:50.2543687+00:00",
"date_out_of_production_since": "2026-04-07T05:33:50.2543687+00:00",
"date_end_support": "2026-04-07T05:33:50.2543687+00:00",
"sales_organization_id": "80b9e252-f83b-4fd5-b142-0b9d1c632ef1",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "858fb45c-6f7f-492c-ae81-11a0aef6b6df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "19d7ea56-a13d-4853-865b-adac0e317a4a",
"db_currency_id": "a62fda9a-070f-4200-a4e1-a6a03cf2e987",
"db_language_id": "8fd7386e-a75e-434b-9917-1f2c5c4d1c25",
"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-04-07T05:33:50.2543687+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-04-07T05:33:50.2543687+00:00"
},
"project_status_id": "03d764c1-4989-4b56-a4f2-b2e0834f5ded",
"project_status_code": "sample string 10",
"project_status": {
"id": "b2249112-19b9-423a-9ad5-c66eac9def55",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "986f4f00-54b5-44e6-99f8-cf987b830c0a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "858fb45c-6f7f-492c-ae81-11a0aef6b6df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "19d7ea56-a13d-4853-865b-adac0e317a4a",
"db_currency_id": "a62fda9a-070f-4200-a4e1-a6a03cf2e987",
"db_language_id": "8fd7386e-a75e-434b-9917-1f2c5c4d1c25",
"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-04-07T05:33:50.2543687+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-07T05:33:50.2543687+00:00"
},
"company_id": "ed0f7d76-e78e-4a9b-b2a0-0dae03fc4b39",
"company_code": "sample string 12",
"db_address_id": "6848fe3a-c825-42bf-a832-233e2898f5f2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "94f97859-ce38-4266-a021-e6bf9532d4c1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bc220ce4-2397-4ec2-914c-724ca9719455",
"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-04-07T05:33:50.2543687+00:00",
"date_create": "2026-04-07T05:33:50.2543687+00:00",
"date_update": "2026-04-07T05:33:50.2543687+00:00",
"updated_by_user_id": "b428f157-708b-477f-8c89-8b22efc13c35",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-07T05:33:50.2543687+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-04-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-07T05:33:50.2543687+00:00",
"date_last_job": "2026-04-07T05:33:50.2543687+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-07T05:33:50.2543687+00:00",
"modified_dateutc": "2026-04-07T05:33:50.2543687+00:00",
"is_mobile_installation": true
},
"job_type_id": "ffb46d18-7c3b-46c8-acfa-2cd4675c3e4e",
"job_type_code": "sample string 7",
"job_type": {
"id": "45d89768-0f23-4a8e-bfea-67cac4611d72",
"name": "sample string 2",
"sales_organization_id": "25eb0983-638d-48a5-88a5-af255148602e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-07T05:33:50.2543687+00:00",
"code": "sample string 7"
},
"job_priority_id": "ce1718d0-c9ad-4b8c-ab12-db31b9ae1445",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2f38fffd-d3b4-4fa0-bd94-e11e9c66f139",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9421dc10-7b69-4e67-a23c-03aeb45e10c2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "858fb45c-6f7f-492c-ae81-11a0aef6b6df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "19d7ea56-a13d-4853-865b-adac0e317a4a",
"db_currency_id": "a62fda9a-070f-4200-a4e1-a6a03cf2e987",
"db_language_id": "8fd7386e-a75e-434b-9917-1f2c5c4d1c25",
"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-04-07T05:33:50.2543687+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-07T05:33:50.2543687+00:00"
},
"job_status_id": "a383ada1-a196-4dac-b516-e2910886a113",
"job_status_code": "sample string 11",
"db_address_id": "a674be1a-b42c-442c-8ffa-c2dcbc48c5b4",
"contact_id": "a400e542-bc76-44c3-a9d6-fb257c58ec23",
"requested_by_company_id": "37fee04e-c2c6-4445-a2b9-e59a7a74ec10",
"requested_by_contact_id": "184cf311-05ae-4e6c-b2c9-a559249cec28",
"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-04-07T05:33:50.2543687+00:00",
"due_date": "2026-04-07T05:33:50.2543687+00:00",
"date_create": "2026-04-07T05:33:50.2543687+00:00",
"date_update": "2026-04-07T05:33:50.2543687+00:00",
"date_closed": "2026-04-07T05:33:50.2543687+00:00",
"suggested_user_id": "b03ce09d-a3f2-4cb7-9cf0-ed6cf2142204",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7fda521b-f17d-4b35-b46d-4e7f9c7df828",
"db_language_id": "56363288-71a6-49f8-a055-acca66c5b5c8",
"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-04-07T05:33:50.2543687+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "fd502f3e-719e-45ad-a70b-cbed44184aaf",
"sales_organization": {
"id": "858fb45c-6f7f-492c-ae81-11a0aef6b6df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "19d7ea56-a13d-4853-865b-adac0e317a4a",
"db_currency_id": "a62fda9a-070f-4200-a4e1-a6a03cf2e987",
"db_language_id": "8fd7386e-a75e-434b-9917-1f2c5c4d1c25",
"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-04-07T05:33:50.2543687+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "cea26d24-aa5f-474e-826c-825adb682e05",
"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": "4b6779ce-cce1-4808-bcbf-951142a489d8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-07T05:33:50.2543687+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "cc3012e8-1b3f-404a-ae58-15776696906d"
},
"suggested_date_start": "2026-04-07T05:33:50.2543687+00:00",
"skill_id": "3194359e-31ed-49e3-977b-2e728fbc99f1",
"skill_code": "sample string 32",
"skill": {
"id": "56dbbef7-0741-40b2-be67-0c840d099e53",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "929ddf34-294b-4269-adeb-b80588732663",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "858fb45c-6f7f-492c-ae81-11a0aef6b6df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "19d7ea56-a13d-4853-865b-adac0e317a4a",
"db_currency_id": "a62fda9a-070f-4200-a4e1-a6a03cf2e987",
"db_language_id": "8fd7386e-a75e-434b-9917-1f2c5c4d1c25",
"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-04-07T05:33:50.2543687+00:00"
},
"modified_dateutc": "2026-04-07T05:33:50.2543687+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "863298f6-afcb-4db9-adf2-824f8d8c97fd",
"date_reported_by_company": "2026-04-07T05:33:50.2543687+00:00",
"id2": 36,
"company_id": "8899e03f-0953-4eae-81cf-eb2559784d4f",
"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": "b729663e-d96b-4026-a59e-9f09105088f7",
"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-04-07T05:33:50.2543687+00:00"
},
"work_instruction_details_id": "1fc85a75-9fb8-4efc-a9b7-48ac45913a2d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1165f22e-02c8-4c9a-8f45-80e01f10dd40",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "66337866-4c2d-4320-b05c-e193225c5872",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-07T05:33:50.2543687+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": "164d41e0-3c7f-4307-bcb0-20e51e9f46f9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-07T05:33:50.2543687+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.