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": "bced2c1c-2cf9-4e68-be8b-4dbe1a3bc7c8",
"jobs_id": "17bb3ac7-252a-43d2-ad56-2435cfe12362",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "faacb6d9-bab5-451f-88fc-ba68f985e26c",
"_parent_id": "45769552-f0ed-4384-9692-1e093e95e17c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "782f533a-a20a-43af-a884-dc3112b74d96",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1941d4df-7382-41ee-b176-353850607c2f",
"_parent_id": "edeae11a-a316-44fb-ba6d-877cd96e0289",
"root_parent_id": "718ea36b-76c5-4aa6-b1d4-c2a8021e0748",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "95f8b2c2-6b46-49fb-8fd6-c01678c20be7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ab1ede56-8d4c-4bdd-9de9-9490c836df59",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fe4594ef-1e57-41fb-bc80-5d41d426e462",
"_parent_code": "sample string 6",
"sales_organization_id": "6461d2f8-a2c9-4674-af4c-1f7aef833912",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "538ee1eb-5a97-4b36-9fed-55cb03ebff99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cc3bec2a-4c0f-4679-b434-56d238f3ca0b",
"db_currency_id": "77a0f21f-ee97-493f-bff3-5da921413621",
"db_language_id": "aef47778-c780-4d51-82c9-4537bb7a3cef",
"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-08-23T16:48:18.6457274+00:00"
},
"modified_dateutc": "2026-08-23T16:48:18.6457274+00:00"
},
"equipment_model_id": "a511e164-c50c-48d5-8bc3-b1391f80b114",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "023d9b2e-3dcd-4f01-a07e-ab8e676fc797",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "de4875a1-5ffa-44dd-bd02-aa155890aaa2",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4fac477c-e89c-4b92-b7e7-51ed12428738",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0f7607f1-4fea-407f-b462-5d4c429dea67",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "538ee1eb-5a97-4b36-9fed-55cb03ebff99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cc3bec2a-4c0f-4679-b434-56d238f3ca0b",
"db_currency_id": "77a0f21f-ee97-493f-bff3-5da921413621",
"db_language_id": "aef47778-c780-4d51-82c9-4537bb7a3cef",
"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-08-23T16:48:18.6457274+00:00"
},
"modified_dateutc": "2026-08-23T16:48:18.6457274+00:00"
},
"equipment_family_id": "a55c0104-976f-4fb3-85c9-9913abe25c32",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ab1ede56-8d4c-4bdd-9de9-9490c836df59",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fe4594ef-1e57-41fb-bc80-5d41d426e462",
"_parent_code": "sample string 6",
"sales_organization_id": "6461d2f8-a2c9-4674-af4c-1f7aef833912",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "538ee1eb-5a97-4b36-9fed-55cb03ebff99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cc3bec2a-4c0f-4679-b434-56d238f3ca0b",
"db_currency_id": "77a0f21f-ee97-493f-bff3-5da921413621",
"db_language_id": "aef47778-c780-4d51-82c9-4537bb7a3cef",
"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-08-23T16:48:18.6457274+00:00"
},
"modified_dateutc": "2026-08-23T16:48:18.6457274+00:00"
},
"date_in_production_since": "2026-08-23T16:48:18.6457274+00:00",
"date_out_of_production_since": "2026-08-23T16:48:18.6457274+00:00",
"date_end_support": "2026-08-23T16:48:18.6457274+00:00",
"sales_organization_id": "1723d454-55cc-459f-879e-abffc0ec84c2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "538ee1eb-5a97-4b36-9fed-55cb03ebff99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cc3bec2a-4c0f-4679-b434-56d238f3ca0b",
"db_currency_id": "77a0f21f-ee97-493f-bff3-5da921413621",
"db_language_id": "aef47778-c780-4d51-82c9-4537bb7a3cef",
"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-08-23T16:48:18.6457274+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-08-23T16:48:18.6457274+00:00"
},
"project_status_id": "53071e13-8b06-40ce-ae77-58e2c1d3e699",
"project_status_code": "sample string 10",
"project_status": {
"id": "c62f2e2f-a976-40fd-ae1c-090d7102bffb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b885c453-3c35-49ab-a954-61adaa6f4671",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "538ee1eb-5a97-4b36-9fed-55cb03ebff99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cc3bec2a-4c0f-4679-b434-56d238f3ca0b",
"db_currency_id": "77a0f21f-ee97-493f-bff3-5da921413621",
"db_language_id": "aef47778-c780-4d51-82c9-4537bb7a3cef",
"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-08-23T16:48:18.6457274+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-23T16:48:18.6457274+00:00"
},
"company_id": "7005b74d-49fd-47ed-a07a-9e6fc25b66c9",
"company_code": "sample string 12",
"db_address_id": "467e99d8-0338-4040-b264-8a68657103fe",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "299c3094-59e4-4d0f-a519-0255d957a625",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bd5bad87-0d53-4f98-af3c-552ebd80eb90",
"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-08-23T16:48:18.6457274+00:00",
"date_create": "2026-08-23T16:48:18.6457274+00:00",
"date_update": "2026-08-23T16:48:18.6457274+00:00",
"updated_by_user_id": "83dbd409-4696-443d-a7fb-56620697fc07",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-23T16:48:18.6457274+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-08-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-23T16:48:18.6457274+00:00",
"date_last_job": "2026-08-23T16:48:18.6457274+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-23T16:48:18.6457274+00:00",
"modified_dateutc": "2026-08-23T16:48:18.6457274+00:00",
"is_mobile_installation": true
},
"job_type_id": "4035e6e2-1820-4dc7-8923-f16e6f5f392d",
"job_type_code": "sample string 7",
"job_type": {
"id": "c33b1b69-841e-47d6-bfc4-52672e3e2d4c",
"name": "sample string 2",
"sales_organization_id": "650b8ec1-3aa8-4ac1-8374-19a53a671982",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-23T16:48:18.6457274+00:00",
"code": "sample string 7"
},
"job_priority_id": "4a29b20d-74c0-4f34-9ceb-bf5e8270df95",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "05980984-9a55-4531-a444-41020df6c656",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "66ecf842-452a-4d3d-88fe-3bd3deccd086",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "538ee1eb-5a97-4b36-9fed-55cb03ebff99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cc3bec2a-4c0f-4679-b434-56d238f3ca0b",
"db_currency_id": "77a0f21f-ee97-493f-bff3-5da921413621",
"db_language_id": "aef47778-c780-4d51-82c9-4537bb7a3cef",
"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-08-23T16:48:18.6457274+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-23T16:48:18.6457274+00:00"
},
"job_status_id": "0c7baa15-a57d-484b-977a-a8e475ba4066",
"job_status_code": "sample string 11",
"db_address_id": "87ff69b0-30d0-414f-8ee5-3499dfad7a7d",
"contact_id": "48dce70e-27fb-4506-b645-e2b071162e97",
"requested_by_company_id": "57410053-9ce1-4954-b275-e9e8dbb3d519",
"requested_by_contact_id": "c148b84a-1e8a-4a34-8315-61b76ad671b1",
"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-08-23T16:48:18.6457274+00:00",
"due_date": "2026-08-23T16:48:18.6457274+00:00",
"date_create": "2026-08-23T16:48:18.6457274+00:00",
"date_update": "2026-08-23T16:48:18.6457274+00:00",
"date_closed": "2026-08-23T16:48:18.6457274+00:00",
"suggested_user_id": "54d50b4e-a287-48f8-bc69-97e85fe8b919",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b93ecefc-68bf-4daa-8d51-5a9c3bc7dade",
"db_language_id": "842692cc-edea-4b81-89ff-2e7b47a49b30",
"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-08-23T16:48:18.6457274+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0a10baae-b271-4c6c-9550-3d16bc5e69e6",
"sales_organization": {
"id": "538ee1eb-5a97-4b36-9fed-55cb03ebff99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cc3bec2a-4c0f-4679-b434-56d238f3ca0b",
"db_currency_id": "77a0f21f-ee97-493f-bff3-5da921413621",
"db_language_id": "aef47778-c780-4d51-82c9-4537bb7a3cef",
"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-08-23T16:48:18.6457274+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3728d2ec-0e0e-4ccc-a081-47f7a9639175",
"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": "40df45c6-59c5-464b-bbbb-663b9fe0c9ad",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-23T16:48:18.6457274+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "56275401-e871-4b7c-81eb-bb5f36ab5245"
},
"suggested_date_start": "2026-08-23T16:48:18.6457274+00:00",
"skill_id": "dcff0e36-5872-432e-9618-f99436bf0b8c",
"skill_code": "sample string 32",
"skill": {
"id": "6aafb077-2f6a-4a31-83a4-27cdfd3f6442",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "bc9dea50-53b9-475f-bea9-18e43734202f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "538ee1eb-5a97-4b36-9fed-55cb03ebff99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cc3bec2a-4c0f-4679-b434-56d238f3ca0b",
"db_currency_id": "77a0f21f-ee97-493f-bff3-5da921413621",
"db_language_id": "aef47778-c780-4d51-82c9-4537bb7a3cef",
"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-08-23T16:48:18.6457274+00:00"
},
"modified_dateutc": "2026-08-23T16:48:18.6457274+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0580766a-0a58-4c8e-97e6-dcdbb9fc7066",
"date_reported_by_company": "2026-08-23T16:48:18.6457274+00:00",
"id2": 36,
"company_id": "668eeb77-ca2e-47a3-9b5b-c7b07c130497",
"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": "9f31648d-3edc-4fb4-81e3-ea362b38bcb3",
"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-08-23T16:48:18.6457274+00:00"
},
"work_instruction_details_id": "3797c52b-605e-4b60-92c1-6e2a52f9d88a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "790c5c11-7905-40fe-8213-f03988ca984f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d967e6a6-ba40-47e0-8a00-da253eef6aed",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-23T16:48:18.6457274+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": "46876510-4dab-4abe-ac60-9c7d3c78ce94",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-23T16:48:18.6457274+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.