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": "1eeb8cfb-dd34-4394-abf9-b9415551f4ec",
"jobs_id": "20b26ac8-1099-400a-9fee-ce21b6ee152e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9984cbea-fbca-4018-873f-7ca7ec4a96ba",
"_parent_id": "952f95bd-2739-48d5-aef2-8031adc2dec7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "74ed2fc1-1353-4b17-927d-4dc7d9654501",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c5a8e307-5997-4098-9eab-06f70dee18f5",
"_parent_id": "d721db4f-8733-4698-8501-92cd826b7a0f",
"root_parent_id": "9d3b3e20-6206-4395-9bac-89d2c63826a0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9a706f81-076a-4377-a452-2f2fe7ab5f08",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9211ccd0-4a62-48ca-8978-7fba7e657a74",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a35ef002-412e-4682-b003-2cbf6166d0e4",
"_parent_code": "sample string 6",
"sales_organization_id": "5708d820-3147-4920-b66f-dd82c07c4007",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b177b017-3775-4304-8963-934b8476c326",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "297a22dd-9c85-49ca-aefb-c42e3c21fe9c",
"db_currency_id": "88b416a2-7f62-411b-a791-426b451a3073",
"db_language_id": "0a082a4a-a331-4117-b155-8c15992ee99b",
"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-07-07T09:44:20.2929334+00:00"
},
"modified_dateutc": "2026-07-07T09:44:20.2929334+00:00"
},
"equipment_model_id": "05f796ca-8f6e-434b-841d-5b7fcab4fb31",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d258cd00-0c1b-4873-8996-d86c7f739ca4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8ebfa424-2a7c-441c-8d96-f58bbd2b5b13",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8d8ba7fb-38ca-441d-8764-f4150e3b2b62",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4d6f30e6-a5e8-41be-bc1d-ee5724b1031b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b177b017-3775-4304-8963-934b8476c326",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "297a22dd-9c85-49ca-aefb-c42e3c21fe9c",
"db_currency_id": "88b416a2-7f62-411b-a791-426b451a3073",
"db_language_id": "0a082a4a-a331-4117-b155-8c15992ee99b",
"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-07-07T09:44:20.2929334+00:00"
},
"modified_dateutc": "2026-07-07T09:44:20.2929334+00:00"
},
"equipment_family_id": "48880421-025b-4e9b-9cbf-8b9268c4274c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9211ccd0-4a62-48ca-8978-7fba7e657a74",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a35ef002-412e-4682-b003-2cbf6166d0e4",
"_parent_code": "sample string 6",
"sales_organization_id": "5708d820-3147-4920-b66f-dd82c07c4007",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b177b017-3775-4304-8963-934b8476c326",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "297a22dd-9c85-49ca-aefb-c42e3c21fe9c",
"db_currency_id": "88b416a2-7f62-411b-a791-426b451a3073",
"db_language_id": "0a082a4a-a331-4117-b155-8c15992ee99b",
"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-07-07T09:44:20.2929334+00:00"
},
"modified_dateutc": "2026-07-07T09:44:20.2929334+00:00"
},
"date_in_production_since": "2026-07-07T09:44:20.2929334+00:00",
"date_out_of_production_since": "2026-07-07T09:44:20.2929334+00:00",
"date_end_support": "2026-07-07T09:44:20.2929334+00:00",
"sales_organization_id": "7d17f25f-73ac-4208-9a78-55030ecaf102",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b177b017-3775-4304-8963-934b8476c326",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "297a22dd-9c85-49ca-aefb-c42e3c21fe9c",
"db_currency_id": "88b416a2-7f62-411b-a791-426b451a3073",
"db_language_id": "0a082a4a-a331-4117-b155-8c15992ee99b",
"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-07-07T09:44:20.2929334+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-07-07T09:44:20.2929334+00:00"
},
"project_status_id": "e4b0740b-08ae-4257-ab48-d96a72c5a0e7",
"project_status_code": "sample string 10",
"project_status": {
"id": "972ae433-e6fa-48cf-9574-dbca4507c255",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "af9eeb13-ae73-4efa-8d97-fd3cc39e8687",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b177b017-3775-4304-8963-934b8476c326",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "297a22dd-9c85-49ca-aefb-c42e3c21fe9c",
"db_currency_id": "88b416a2-7f62-411b-a791-426b451a3073",
"db_language_id": "0a082a4a-a331-4117-b155-8c15992ee99b",
"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-07-07T09:44:20.2929334+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-07T09:44:20.2929334+00:00"
},
"company_id": "93970681-de6b-4a35-b437-a07936d2dbdc",
"company_code": "sample string 12",
"db_address_id": "c0ccce52-9c5d-4ccd-94c7-4a8602c15e14",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7c9cf9d3-1b15-48d1-8351-8cae82c75f60",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b35bcaaf-c22c-4c8b-a0d7-94b6de9bb6fe",
"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-07-07T09:44:20.2929334+00:00",
"date_create": "2026-07-07T09:44:20.2929334+00:00",
"date_update": "2026-07-07T09:44:20.2929334+00:00",
"updated_by_user_id": "415eafcc-deb1-445d-a766-e9f8aa2e4fc3",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-07T09:44:20.2929334+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-07-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-07T09:44:20.2929334+00:00",
"date_last_job": "2026-07-07T09:44:20.2929334+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-07T09:44:20.2929334+00:00",
"modified_dateutc": "2026-07-07T09:44:20.2929334+00:00",
"is_mobile_installation": true
},
"job_type_id": "e92506e3-f261-4ab5-884d-3333018fb17f",
"job_type_code": "sample string 7",
"job_type": {
"id": "c975c8f1-5677-4319-a66d-666c7b138d01",
"name": "sample string 2",
"sales_organization_id": "d588d195-40eb-4f36-9351-8e4da347002d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-07T09:44:20.2929334+00:00",
"code": "sample string 7"
},
"job_priority_id": "27cda89c-4941-4716-a63f-3c4589f19aa8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "74e96eca-dc67-46bf-97f3-18d58975f55b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ec10fc5f-f6c7-4e4d-9cf2-6e4e6f214e8e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b177b017-3775-4304-8963-934b8476c326",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "297a22dd-9c85-49ca-aefb-c42e3c21fe9c",
"db_currency_id": "88b416a2-7f62-411b-a791-426b451a3073",
"db_language_id": "0a082a4a-a331-4117-b155-8c15992ee99b",
"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-07-07T09:44:20.2929334+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-07T09:44:20.2929334+00:00"
},
"job_status_id": "7fba0bff-d34a-4e33-a1cd-612c71e8abb4",
"job_status_code": "sample string 11",
"db_address_id": "94b0081e-c0c9-4cb2-ad2a-bd84dffb6d4d",
"contact_id": "31c9c368-03a0-47d1-b72c-93ece2e76116",
"requested_by_company_id": "94be8a55-3456-48eb-b3a8-2d4c1ecee86c",
"requested_by_contact_id": "15daf5ee-9c62-4034-9437-cb76856798bc",
"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-07-07T09:44:20.2929334+00:00",
"due_date": "2026-07-07T09:44:20.2929334+00:00",
"date_create": "2026-07-07T09:44:20.2929334+00:00",
"date_update": "2026-07-07T09:44:20.2929334+00:00",
"date_closed": "2026-07-07T09:44:20.2929334+00:00",
"suggested_user_id": "e3776756-d2eb-4cf5-9650-ed8507dbf2d9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "808eea1e-7711-4a54-9e54-5fc23bdeef81",
"db_language_id": "89e5ebc1-0835-43bb-816b-8af4c41dc376",
"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-07-07T09:44:20.2929334+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3d95d2ed-05ac-4bd3-ba91-dcde016f14fd",
"sales_organization": {
"id": "b177b017-3775-4304-8963-934b8476c326",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "297a22dd-9c85-49ca-aefb-c42e3c21fe9c",
"db_currency_id": "88b416a2-7f62-411b-a791-426b451a3073",
"db_language_id": "0a082a4a-a331-4117-b155-8c15992ee99b",
"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-07-07T09:44:20.2929334+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5fa40c94-7203-4d0b-adb8-82408ca073b8",
"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": "3a633997-02b7-415d-bd5d-d2b3c597bfdc",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-07T09:44:20.2929334+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5f19f706-d32f-4f50-bdb0-eb3180ee4dcd"
},
"suggested_date_start": "2026-07-07T09:44:20.2929334+00:00",
"skill_id": "2e135783-f899-48d2-9949-ec4d7595cd46",
"skill_code": "sample string 32",
"skill": {
"id": "f436fb30-bb59-4302-8173-5a997cdd6293",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "da32d962-b6bf-4934-84ef-bac9b8eab0f5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b177b017-3775-4304-8963-934b8476c326",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "297a22dd-9c85-49ca-aefb-c42e3c21fe9c",
"db_currency_id": "88b416a2-7f62-411b-a791-426b451a3073",
"db_language_id": "0a082a4a-a331-4117-b155-8c15992ee99b",
"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-07-07T09:44:20.2929334+00:00"
},
"modified_dateutc": "2026-07-07T09:44:20.2929334+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b2073049-9c7c-487a-8bbb-cc2e3ab6a4d1",
"date_reported_by_company": "2026-07-07T09:44:20.2929334+00:00",
"id2": 36,
"company_id": "e40ff3d2-c878-4204-b3b8-591a7f0a3e55",
"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": "8579a573-24b3-494f-9e3a-2ef09181ec7e",
"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-07-07T09:44:20.2929334+00:00"
},
"work_instruction_details_id": "e7ee5de3-6e19-4aa7-b2fd-9fc8cab048c1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "18f094b7-ef87-4c1f-8dcd-ceaaf4a8bbb0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "aa6f664d-9c65-48ce-bf62-d7078c5bb34b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-07T09:44:20.2929334+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": "4ded61a2-1de1-4da9-9f98-44a20a399f6a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-07T09:44:20.2929334+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.