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": "dd61eb77-f44a-46b3-bf57-2bd6fffa9fd4",
"jobs_id": "b2db81ce-de4d-4afa-adff-c0d512d233e5",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9cc6702b-173d-4910-b6cd-d93dfb67bd10",
"_parent_id": "c340fb71-5952-4552-8baa-3116c1555eee",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "dca38154-b7f2-47fe-bd0e-b956c22b1834",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e96b3ce9-d365-4580-98a1-c22a2e83624f",
"_parent_id": "887f7f18-a853-4200-af3b-afacc2cb5f43",
"root_parent_id": "52bdcbb4-031b-4f53-b497-26034a83a01c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "05468a94-c75e-4999-8745-7c7f18d165ee",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "18105f7c-483f-41a7-9ce2-3ad8f4d1e9db",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b320dc42-7937-4d28-925c-1e621b671121",
"_parent_code": "sample string 6",
"sales_organization_id": "cb4c8be8-cde8-4d24-b12e-908dc719646f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a8338b8c-2fc8-403d-af7e-f6ff4695bc74",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba3907f0-596a-45e4-b510-3ab68edd5d44",
"db_currency_id": "f90bd6ef-8c6e-44b9-a0c9-d76b05a83aa1",
"db_language_id": "73e87ea1-07f6-4036-95e0-64903e7594e9",
"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-11T06:01:26.2317071+00:00"
},
"modified_dateutc": "2026-08-11T06:01:26.2317071+00:00"
},
"equipment_model_id": "a41f4bc9-872f-46f2-ae94-f57c5a793eea",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d14edc13-27bc-4778-8aa9-36fc63ada8bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "fd4f99a5-cda6-4256-869a-0c38b3408228",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c15a9cf9-84b1-4edc-8d3c-83f53a2ae596",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3ed1fca1-e4d2-453e-a972-526a04d5343e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a8338b8c-2fc8-403d-af7e-f6ff4695bc74",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba3907f0-596a-45e4-b510-3ab68edd5d44",
"db_currency_id": "f90bd6ef-8c6e-44b9-a0c9-d76b05a83aa1",
"db_language_id": "73e87ea1-07f6-4036-95e0-64903e7594e9",
"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-11T06:01:26.2317071+00:00"
},
"modified_dateutc": "2026-08-11T06:01:26.2317071+00:00"
},
"equipment_family_id": "93db12e1-80a5-475c-9fe7-ccead0420499",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "18105f7c-483f-41a7-9ce2-3ad8f4d1e9db",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b320dc42-7937-4d28-925c-1e621b671121",
"_parent_code": "sample string 6",
"sales_organization_id": "cb4c8be8-cde8-4d24-b12e-908dc719646f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a8338b8c-2fc8-403d-af7e-f6ff4695bc74",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba3907f0-596a-45e4-b510-3ab68edd5d44",
"db_currency_id": "f90bd6ef-8c6e-44b9-a0c9-d76b05a83aa1",
"db_language_id": "73e87ea1-07f6-4036-95e0-64903e7594e9",
"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-11T06:01:26.2317071+00:00"
},
"modified_dateutc": "2026-08-11T06:01:26.2317071+00:00"
},
"date_in_production_since": "2026-08-11T06:01:26.2317071+00:00",
"date_out_of_production_since": "2026-08-11T06:01:26.2317071+00:00",
"date_end_support": "2026-08-11T06:01:26.2317071+00:00",
"sales_organization_id": "0d27f833-a2a2-459f-b91b-aa7fe725e407",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a8338b8c-2fc8-403d-af7e-f6ff4695bc74",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba3907f0-596a-45e4-b510-3ab68edd5d44",
"db_currency_id": "f90bd6ef-8c6e-44b9-a0c9-d76b05a83aa1",
"db_language_id": "73e87ea1-07f6-4036-95e0-64903e7594e9",
"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-11T06:01:26.2317071+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-11T06:01:26.2317071+00:00"
},
"project_status_id": "7beb8d2a-7be6-4e81-8d99-a7e7712a3c48",
"project_status_code": "sample string 10",
"project_status": {
"id": "e490563d-767d-46bc-a690-ee1239a3f8fe",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4a8a9a63-02c6-4900-99e7-01168375b95a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a8338b8c-2fc8-403d-af7e-f6ff4695bc74",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba3907f0-596a-45e4-b510-3ab68edd5d44",
"db_currency_id": "f90bd6ef-8c6e-44b9-a0c9-d76b05a83aa1",
"db_language_id": "73e87ea1-07f6-4036-95e0-64903e7594e9",
"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-11T06:01:26.2317071+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-11T06:01:26.2317071+00:00"
},
"company_id": "6510e822-a7f2-4a13-88b0-955ce5a43778",
"company_code": "sample string 12",
"db_address_id": "51c4f6bf-8c97-43d8-82ae-d3e23f708a42",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d87651cd-207f-4ce4-be5a-4d5cd3568b94",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d0fe77f2-a46e-4354-b8ef-8a3d30b8286a",
"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-11T06:01:26.2317071+00:00",
"date_create": "2026-08-11T06:01:26.2317071+00:00",
"date_update": "2026-08-11T06:01:26.2317071+00:00",
"updated_by_user_id": "b5ec0dee-6345-4b82-931e-38fde7b430a3",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-11T06:01:26.2473299+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-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-11T06:01:26.2473299+00:00",
"date_last_job": "2026-08-11T06:01:26.2473299+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-11T06:01:26.2473299+00:00",
"modified_dateutc": "2026-08-11T06:01:26.2473299+00:00",
"is_mobile_installation": true
},
"job_type_id": "22c15699-7595-4cd2-8c77-80a06a4f29db",
"job_type_code": "sample string 7",
"job_type": {
"id": "d63f6f01-7b07-4c0d-9f83-ef3209b9e73c",
"name": "sample string 2",
"sales_organization_id": "0763660f-ea9c-4799-8bc0-738413ee1c5d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-11T06:01:26.2473299+00:00",
"code": "sample string 7"
},
"job_priority_id": "286c7b05-4a4f-4555-ac53-06788931ee7e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8dee4eb1-7a13-445c-92ff-dd7fb54dbe19",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d2dc2866-11b2-4dca-a927-cb6f4bd76622",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a8338b8c-2fc8-403d-af7e-f6ff4695bc74",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba3907f0-596a-45e4-b510-3ab68edd5d44",
"db_currency_id": "f90bd6ef-8c6e-44b9-a0c9-d76b05a83aa1",
"db_language_id": "73e87ea1-07f6-4036-95e0-64903e7594e9",
"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-11T06:01:26.2317071+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-11T06:01:26.2473299+00:00"
},
"job_status_id": "4280d314-c4c1-4543-afd3-2ba13c59094c",
"job_status_code": "sample string 11",
"db_address_id": "42896a1a-3e9e-46bc-a338-dca7659e7d5e",
"contact_id": "190fe915-db29-49fd-ac7b-e18bf132b99c",
"requested_by_company_id": "ba00c964-6f12-4337-8755-2f24757f2086",
"requested_by_contact_id": "09a128ca-7f95-4f8d-a348-1b90a16ef789",
"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-11T06:01:26.2473299+00:00",
"due_date": "2026-08-11T06:01:26.2473299+00:00",
"date_create": "2026-08-11T06:01:26.2473299+00:00",
"date_update": "2026-08-11T06:01:26.2473299+00:00",
"date_closed": "2026-08-11T06:01:26.2473299+00:00",
"suggested_user_id": "03567e75-56d3-4eda-97a0-f7d37cbe796f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6005d87c-6db3-4ea7-ae2f-2619e0790d79",
"db_language_id": "864d4e8d-8ac4-4f30-b793-05c089b33f56",
"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-11T06:01:26.2473299+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "728152f9-99b5-49f9-ac30-1fa702288b5c",
"sales_organization": {
"id": "a8338b8c-2fc8-403d-af7e-f6ff4695bc74",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba3907f0-596a-45e4-b510-3ab68edd5d44",
"db_currency_id": "f90bd6ef-8c6e-44b9-a0c9-d76b05a83aa1",
"db_language_id": "73e87ea1-07f6-4036-95e0-64903e7594e9",
"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-11T06:01:26.2317071+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5088e5eb-6a2c-4592-b2e3-7a3679581a4d",
"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": "0fe7472d-5b36-48bb-90ac-9aa03f2b9e03",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-11T06:01:26.2473299+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f0e48bcb-8143-4bbb-b86b-139d8e686685"
},
"suggested_date_start": "2026-08-11T06:01:26.2473299+00:00",
"skill_id": "75e481c0-d90e-4a5f-af69-f6fc98a76232",
"skill_code": "sample string 32",
"skill": {
"id": "43d8880c-376b-44fa-9531-4b880c3cad37",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1c8aaad5-998f-459f-be5f-a64aec99474c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a8338b8c-2fc8-403d-af7e-f6ff4695bc74",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba3907f0-596a-45e4-b510-3ab68edd5d44",
"db_currency_id": "f90bd6ef-8c6e-44b9-a0c9-d76b05a83aa1",
"db_language_id": "73e87ea1-07f6-4036-95e0-64903e7594e9",
"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-11T06:01:26.2317071+00:00"
},
"modified_dateutc": "2026-08-11T06:01:26.2473299+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "71aaf63f-52e9-4d2d-89d1-b3bbf9ec6ee4",
"date_reported_by_company": "2026-08-11T06:01:26.2473299+00:00",
"id2": 36,
"company_id": "66d10478-9e7d-42de-8422-2daed07d3e5f",
"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": "ea96ff3b-8b8b-46ea-a7a6-0bf88be7169f",
"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-11T06:01:26.2473299+00:00"
},
"work_instruction_details_id": "aa595e65-ef2c-48d9-b13e-308626b63f73",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b66b8aac-8ade-494a-9114-d9393dfd5502",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b652a4a6-f42c-4850-80f6-94e930891206",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-11T06:01:26.2473299+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": "d0596664-981f-4364-b428-87a6773c3175",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-11T06:01:26.2473299+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.