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": "f0fc9fa9-61aa-4b52-ab94-780324339c83",
"jobs_id": "612b6bb5-c711-4eaf-abff-f6c80d098148",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6f12377a-4154-4d4c-b771-0fa863c88130",
"_parent_id": "9656b9ce-d5d5-438b-b587-20bffa25e4ba",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f706093e-96c8-4e28-8b8c-24eb04ec27b8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f3ff05fe-210b-49b8-915a-0c02b2d5ccc0",
"_parent_id": "77f8cbd4-bf1a-4515-8697-e1a18eac2491",
"root_parent_id": "8acb98b4-42db-4423-9e49-d106c3b8a1fc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "32ec6219-3799-451d-a649-5bc77a926c1f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ee6dcffd-4efe-47b3-9373-23f9f44db72b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "187d0a8f-1b5b-4861-a0f6-118b375027c9",
"_parent_code": "sample string 6",
"sales_organization_id": "dc14bf5e-ee72-4797-bb6d-e1fd930d443e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "788bb30e-61ee-40d5-8bc8-24dfb0ed5876",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ac454a9-9016-42ef-80b5-9fb3c71a7a31",
"db_currency_id": "ca2e2ab0-c418-4a23-b748-f61186db3032",
"db_language_id": "ea018a81-a573-4a6e-82ee-82c100d54940",
"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-03T07:36:04.0679373+00:00"
},
"modified_dateutc": "2026-07-03T07:36:04.0679373+00:00"
},
"equipment_model_id": "cdb60f59-ac12-4963-a8ef-5a2c4d7bd879",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "64813086-d524-47fb-be87-f25123c18fe6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "58552dc9-ef78-4121-90c2-e217b40ff10d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1aca88f6-dee8-460f-81e1-d62e4b950600",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9eab287d-a30a-411a-924a-efed51a035e3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "788bb30e-61ee-40d5-8bc8-24dfb0ed5876",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ac454a9-9016-42ef-80b5-9fb3c71a7a31",
"db_currency_id": "ca2e2ab0-c418-4a23-b748-f61186db3032",
"db_language_id": "ea018a81-a573-4a6e-82ee-82c100d54940",
"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-03T07:36:04.0679373+00:00"
},
"modified_dateutc": "2026-07-03T07:36:04.0679373+00:00"
},
"equipment_family_id": "e1a86c10-9dba-4c53-a6f9-de24dbfea4c3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ee6dcffd-4efe-47b3-9373-23f9f44db72b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "187d0a8f-1b5b-4861-a0f6-118b375027c9",
"_parent_code": "sample string 6",
"sales_organization_id": "dc14bf5e-ee72-4797-bb6d-e1fd930d443e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "788bb30e-61ee-40d5-8bc8-24dfb0ed5876",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ac454a9-9016-42ef-80b5-9fb3c71a7a31",
"db_currency_id": "ca2e2ab0-c418-4a23-b748-f61186db3032",
"db_language_id": "ea018a81-a573-4a6e-82ee-82c100d54940",
"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-03T07:36:04.0679373+00:00"
},
"modified_dateutc": "2026-07-03T07:36:04.0679373+00:00"
},
"date_in_production_since": "2026-07-03T07:36:04.0679373+00:00",
"date_out_of_production_since": "2026-07-03T07:36:04.0679373+00:00",
"date_end_support": "2026-07-03T07:36:04.0679373+00:00",
"sales_organization_id": "ddd82fb2-90f8-4e73-a1cd-e19b858b8fcc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "788bb30e-61ee-40d5-8bc8-24dfb0ed5876",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ac454a9-9016-42ef-80b5-9fb3c71a7a31",
"db_currency_id": "ca2e2ab0-c418-4a23-b748-f61186db3032",
"db_language_id": "ea018a81-a573-4a6e-82ee-82c100d54940",
"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-03T07:36:04.0679373+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-03T07:36:04.0679373+00:00"
},
"project_status_id": "7444a0c8-0b54-49ee-99c4-9676d073d6cd",
"project_status_code": "sample string 10",
"project_status": {
"id": "ddf30c5d-1015-46bf-b440-5a0370d72349",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8af03274-6b40-4806-adcc-452b617563da",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "788bb30e-61ee-40d5-8bc8-24dfb0ed5876",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ac454a9-9016-42ef-80b5-9fb3c71a7a31",
"db_currency_id": "ca2e2ab0-c418-4a23-b748-f61186db3032",
"db_language_id": "ea018a81-a573-4a6e-82ee-82c100d54940",
"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-03T07:36:04.0679373+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-03T07:36:04.0679373+00:00"
},
"company_id": "2e2875b3-9a1b-4336-abd1-c9d4297320fb",
"company_code": "sample string 12",
"db_address_id": "9c863a44-67f4-41cf-b334-3f5f2e85cfe1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "432cb4ed-c758-48fa-b7f8-f947c8a0605b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "240453b2-d38b-4347-9c16-8573b381f95e",
"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-03T07:36:04.0679373+00:00",
"date_create": "2026-07-03T07:36:04.0679373+00:00",
"date_update": "2026-07-03T07:36:04.0679373+00:00",
"updated_by_user_id": "176ba361-04bd-4a5a-9bf7-9442c2942a38",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-03T07:36:04.0679373+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-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-03T07:36:04.0679373+00:00",
"date_last_job": "2026-07-03T07:36:04.0679373+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-03T07:36:04.0679373+00:00",
"modified_dateutc": "2026-07-03T07:36:04.0679373+00:00",
"is_mobile_installation": true
},
"job_type_id": "5b593330-c023-4f4c-a88a-86ddf5ed81b6",
"job_type_code": "sample string 7",
"job_type": {
"id": "cc38c985-525f-4214-a203-745e1ddc04ad",
"name": "sample string 2",
"sales_organization_id": "450823eb-b579-41b9-96a6-43006bc08426",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-03T07:36:04.0679373+00:00",
"code": "sample string 7"
},
"job_priority_id": "05fa8801-cbe8-4743-9f93-e08526dfeffb",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "341aba31-ff8d-4b81-ab25-4d14e58b19b9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ff935b4b-9b56-4464-a8c5-50fc4925512c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "788bb30e-61ee-40d5-8bc8-24dfb0ed5876",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ac454a9-9016-42ef-80b5-9fb3c71a7a31",
"db_currency_id": "ca2e2ab0-c418-4a23-b748-f61186db3032",
"db_language_id": "ea018a81-a573-4a6e-82ee-82c100d54940",
"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-03T07:36:04.0679373+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-03T07:36:04.0679373+00:00"
},
"job_status_id": "fc8bf4b4-6f8f-4c1e-ad74-6c0925564265",
"job_status_code": "sample string 11",
"db_address_id": "e7a7c72c-29f5-436e-926b-75364f57b160",
"contact_id": "5c3789a9-8c1f-4f49-80bb-9cce5c476d8a",
"requested_by_company_id": "d32c78d0-15a5-41c6-827a-f639b47f9c39",
"requested_by_contact_id": "05e3fd92-60cd-4e77-b009-a9db63ad9291",
"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-03T07:36:04.0679373+00:00",
"due_date": "2026-07-03T07:36:04.0679373+00:00",
"date_create": "2026-07-03T07:36:04.0679373+00:00",
"date_update": "2026-07-03T07:36:04.0679373+00:00",
"date_closed": "2026-07-03T07:36:04.0679373+00:00",
"suggested_user_id": "f9b0591a-b451-485f-92b1-d8848281bcec",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "bd19a302-a368-421a-b8ed-ae0d3de9d265",
"db_language_id": "a2ad455a-d5a6-4f8d-a582-4533ab5bf7ec",
"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-03T07:36:04.0679373+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "27146b41-4410-4860-9db7-67d510b538b4",
"sales_organization": {
"id": "788bb30e-61ee-40d5-8bc8-24dfb0ed5876",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ac454a9-9016-42ef-80b5-9fb3c71a7a31",
"db_currency_id": "ca2e2ab0-c418-4a23-b748-f61186db3032",
"db_language_id": "ea018a81-a573-4a6e-82ee-82c100d54940",
"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-03T07:36:04.0679373+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5e6c533c-d578-4a8f-9d1b-435c6e077099",
"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": "4f87f83c-6cf7-4409-96d0-0b635e485cc9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-03T07:36:04.0679373+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a52ec9d0-e4e4-4565-b21e-712dbd5d346d"
},
"suggested_date_start": "2026-07-03T07:36:04.0679373+00:00",
"skill_id": "d002f727-bcbf-45cb-8d46-7042d0431473",
"skill_code": "sample string 32",
"skill": {
"id": "685644f6-bad6-493a-88b8-86a5653f62e0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b51e26df-a300-486e-97ad-c766b5b574ca",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "788bb30e-61ee-40d5-8bc8-24dfb0ed5876",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ac454a9-9016-42ef-80b5-9fb3c71a7a31",
"db_currency_id": "ca2e2ab0-c418-4a23-b748-f61186db3032",
"db_language_id": "ea018a81-a573-4a6e-82ee-82c100d54940",
"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-03T07:36:04.0679373+00:00"
},
"modified_dateutc": "2026-07-03T07:36:04.0679373+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3d6212f2-617b-4a0b-9666-ff74251cbc5a",
"date_reported_by_company": "2026-07-03T07:36:04.0679373+00:00",
"id2": 36,
"company_id": "ffe1f823-fb04-4655-85f6-0b2fbcb8ad16",
"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": "f0d2587a-a04c-4d21-9a10-cd5ecef240f7",
"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-03T07:36:04.0679373+00:00"
},
"work_instruction_details_id": "683bafd8-2bd1-47e3-8416-9715d40139d4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e2aae409-6faa-4e96-bf88-360b009f3e78",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "976bb6c6-b059-4eb3-a34a-3e2c7fa413fa",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-03T07:36:04.0679373+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": "0732b40c-df84-4c5c-bc3a-f4dc48e992ae",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-03T07:36:04.0679373+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.