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": "d3029062-da20-4f73-9ce7-32c57b4db808",
"jobs_id": "ee85cac8-d299-43e5-ada3-c7960e617b4d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b44456d9-1f87-46c9-b7b0-7a8784b21b3f",
"_parent_id": "7c9b8bfe-6d4b-42b7-b42a-93c13be451c8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6b413410-08e9-419e-b9a2-b65baaab7117",
"project_reference_back_office": "sample string 5",
"project": {
"id": "320e1852-fe7f-4080-b2d7-7eccce64f05b",
"_parent_id": "5a89325d-6822-4d22-bf50-8e396b822247",
"root_parent_id": "e7515291-c00c-4284-a365-3af32bd74f4e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a34b4165-8208-442d-b371-df0d53bfa3b0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "34125430-2044-45c3-8ceb-b6f5e445274e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bad71b99-187f-4ebc-94d6-617868936a38",
"_parent_code": "sample string 6",
"sales_organization_id": "7a5bedf2-edb3-4103-a844-5b4844428391",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "48fa7ca2-5156-4ef1-b31f-3441e25573e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "88cbbe79-78b8-438a-83e1-9db901cf322c",
"db_currency_id": "939a5f11-eae4-4b1d-b4a4-d0fcb52fa59d",
"db_language_id": "af65b8ab-e33b-4581-a13e-d3369cb478bb",
"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-09-10T20:47:20.0226911+00:00"
},
"modified_dateutc": "2026-09-10T20:47:20.0226911+00:00"
},
"equipment_model_id": "9383e89c-e01e-45e6-9db2-3f136e628749",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "700facc6-b743-4a0c-be94-7b02d7278b5e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "838212b0-1dcb-4eb0-a8ae-0ff0471999f6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3aabce31-1e06-44df-bfdc-adc8454fe591",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fe1241df-ae24-469a-bbc1-e44055489cd0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "48fa7ca2-5156-4ef1-b31f-3441e25573e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "88cbbe79-78b8-438a-83e1-9db901cf322c",
"db_currency_id": "939a5f11-eae4-4b1d-b4a4-d0fcb52fa59d",
"db_language_id": "af65b8ab-e33b-4581-a13e-d3369cb478bb",
"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-09-10T20:47:20.0226911+00:00"
},
"modified_dateutc": "2026-09-10T20:47:20.0226911+00:00"
},
"equipment_family_id": "c6022ebb-db3c-45ed-ad09-228882e55402",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "34125430-2044-45c3-8ceb-b6f5e445274e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bad71b99-187f-4ebc-94d6-617868936a38",
"_parent_code": "sample string 6",
"sales_organization_id": "7a5bedf2-edb3-4103-a844-5b4844428391",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "48fa7ca2-5156-4ef1-b31f-3441e25573e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "88cbbe79-78b8-438a-83e1-9db901cf322c",
"db_currency_id": "939a5f11-eae4-4b1d-b4a4-d0fcb52fa59d",
"db_language_id": "af65b8ab-e33b-4581-a13e-d3369cb478bb",
"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-09-10T20:47:20.0226911+00:00"
},
"modified_dateutc": "2026-09-10T20:47:20.0226911+00:00"
},
"date_in_production_since": "2026-09-10T20:47:20.0226911+00:00",
"date_out_of_production_since": "2026-09-10T20:47:20.0226911+00:00",
"date_end_support": "2026-09-10T20:47:20.0226911+00:00",
"sales_organization_id": "9918b8c3-0298-4e4b-9fbe-16e4cc62d472",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "48fa7ca2-5156-4ef1-b31f-3441e25573e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "88cbbe79-78b8-438a-83e1-9db901cf322c",
"db_currency_id": "939a5f11-eae4-4b1d-b4a4-d0fcb52fa59d",
"db_language_id": "af65b8ab-e33b-4581-a13e-d3369cb478bb",
"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-09-10T20:47:20.0226911+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-09-10T20:47:20.0226911+00:00"
},
"project_status_id": "5de9c8cc-8290-4580-977c-cb1d29bec343",
"project_status_code": "sample string 10",
"project_status": {
"id": "cb72caba-ddb0-4a50-9fa6-457519a94b0a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e8f0e11c-0aac-4db3-a3e2-0bf72284ab9f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "48fa7ca2-5156-4ef1-b31f-3441e25573e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "88cbbe79-78b8-438a-83e1-9db901cf322c",
"db_currency_id": "939a5f11-eae4-4b1d-b4a4-d0fcb52fa59d",
"db_language_id": "af65b8ab-e33b-4581-a13e-d3369cb478bb",
"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-09-10T20:47:20.0226911+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-10T20:47:20.0226911+00:00"
},
"company_id": "5b3b3112-eeaf-470f-bef4-56c6803a0611",
"company_code": "sample string 12",
"db_address_id": "e1c228ef-ab9f-410f-af5d-f0a1444616b4",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f6d8e6eb-3b7f-4eb3-a066-346dabc6852a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6bf16276-266a-441c-b410-cb897928d6db",
"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-09-10T20:47:20.0226911+00:00",
"date_create": "2026-09-10T20:47:20.0226911+00:00",
"date_update": "2026-09-10T20:47:20.0226911+00:00",
"updated_by_user_id": "216fe6ff-5286-49b4-96c4-ea53ae92bb60",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-10T20:47:20.0226911+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-09-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-10T20:47:20.0226911+00:00",
"date_last_job": "2026-09-10T20:47:20.0226911+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-10T20:47:20.0226911+00:00",
"modified_dateutc": "2026-09-10T20:47:20.0226911+00:00",
"is_mobile_installation": true
},
"job_type_id": "f28672c1-8f28-4c96-877a-9c71a68acf7e",
"job_type_code": "sample string 7",
"job_type": {
"id": "c51aa1b3-76c8-4981-a0dd-65b2303abff2",
"name": "sample string 2",
"sales_organization_id": "0af8adc0-1097-427a-8e2d-708fca41de28",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-10T20:47:20.0226911+00:00",
"code": "sample string 7"
},
"job_priority_id": "9e3226fd-0bf4-44de-98b5-975e9d8b46df",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "dd60ef64-15cf-4223-8d18-87d6507b5a34",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2ce7fecc-a317-4bb8-a117-c8ee2b2d1106",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "48fa7ca2-5156-4ef1-b31f-3441e25573e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "88cbbe79-78b8-438a-83e1-9db901cf322c",
"db_currency_id": "939a5f11-eae4-4b1d-b4a4-d0fcb52fa59d",
"db_language_id": "af65b8ab-e33b-4581-a13e-d3369cb478bb",
"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-09-10T20:47:20.0226911+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-10T20:47:20.0226911+00:00"
},
"job_status_id": "ec358cd9-0c1a-468b-9022-9c9459429716",
"job_status_code": "sample string 11",
"db_address_id": "bdd0e1ae-4b20-4c7b-b837-4946dfc4261a",
"contact_id": "5e6f3af3-ada8-4abf-9b48-d746f2b3f223",
"requested_by_company_id": "d57ddcfd-3287-41e1-9dcb-0128375c9f8a",
"requested_by_contact_id": "6f81a41c-5bda-4979-9875-8cd0ebe7a845",
"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-09-10T20:47:20.0226911+00:00",
"due_date": "2026-09-10T20:47:20.0226911+00:00",
"date_create": "2026-09-10T20:47:20.0226911+00:00",
"date_update": "2026-09-10T20:47:20.0226911+00:00",
"date_closed": "2026-09-10T20:47:20.0226911+00:00",
"suggested_user_id": "226c278b-9ce0-4b26-9c24-fb0758eb55f1",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fb617564-f38e-45d0-9c3d-c62305efd1ca",
"db_language_id": "81f58091-7d6c-4885-af04-483b77763f59",
"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-09-10T20:47:20.0226911+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "dac34884-9a22-4ee3-8483-11d1a33532ec",
"sales_organization": {
"id": "48fa7ca2-5156-4ef1-b31f-3441e25573e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "88cbbe79-78b8-438a-83e1-9db901cf322c",
"db_currency_id": "939a5f11-eae4-4b1d-b4a4-d0fcb52fa59d",
"db_language_id": "af65b8ab-e33b-4581-a13e-d3369cb478bb",
"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-09-10T20:47:20.0226911+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0a94da6c-a58c-4d72-888a-ab917b2112d5",
"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": "21003bf0-79fc-4e7a-a3b0-2337d6304c18",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-10T20:47:20.0226911+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "60699a1a-34c1-4b02-8a3f-39b2f208b078"
},
"suggested_date_start": "2026-09-10T20:47:20.0226911+00:00",
"skill_id": "ea838aae-0820-442c-8eb3-4c1666a865f1",
"skill_code": "sample string 32",
"skill": {
"id": "068cc035-03df-4ad0-adff-ec05b6c97f5e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "dc3cd40c-1e78-41cd-bf1a-576afbfcba71",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "48fa7ca2-5156-4ef1-b31f-3441e25573e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "88cbbe79-78b8-438a-83e1-9db901cf322c",
"db_currency_id": "939a5f11-eae4-4b1d-b4a4-d0fcb52fa59d",
"db_language_id": "af65b8ab-e33b-4581-a13e-d3369cb478bb",
"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-09-10T20:47:20.0226911+00:00"
},
"modified_dateutc": "2026-09-10T20:47:20.0226911+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3b7294b1-fb3a-4e46-bb8f-438405cd0ea4",
"date_reported_by_company": "2026-09-10T20:47:20.0226911+00:00",
"id2": 36,
"company_id": "291dce17-eff3-4e0a-ac4f-2579a9f5febf",
"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": "d8b95ffa-ad2a-43af-8406-0cb27ac9f1e2",
"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-09-10T20:47:20.0226911+00:00"
},
"work_instruction_details_id": "921487f6-29a6-4146-ad6d-0b81e87976db",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b1a9100f-779c-4b50-8e3b-c0163db8ba99",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a8a83c0f-6cbf-4c3e-99f1-74d9bc79ecb1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-10T20:47:20.0226911+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": "bb51b2fd-7380-4a8e-b6c8-a160168af608",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-10T20:47:20.0226911+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.