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": "c3ca1948-809a-414f-9453-3dead1e6bcea",
"jobs_id": "3e665c22-b6e2-4984-b02b-cf59be178a1c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "dba4d1ab-f596-479b-a75c-9ab7217f984c",
"_parent_id": "d95da806-8b06-4e66-8d5b-6b8a3a3f2cd6",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c4069357-817a-466c-a79d-7713971b81fe",
"project_reference_back_office": "sample string 5",
"project": {
"id": "963f2240-3dc6-4afc-be97-a383b02da591",
"_parent_id": "4635b541-9d31-412d-996f-eaec45a12ed9",
"root_parent_id": "345e3468-8a10-4097-8866-a05eb97c2642",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3ec0a220-7591-4763-bbb0-83ea9ca9ca32",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "fb04ef22-a38c-4b0e-9363-fb14366d2353",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8c1c19d7-e9ac-4445-99de-5f47e1c44837",
"_parent_code": "sample string 6",
"sales_organization_id": "a807c4c0-2dd1-4556-8abe-5eb3b59392aa",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "461cfa85-b39a-45bc-b4a5-cc2c0b13c27c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c57ad93e-ba68-4ef1-952b-33cfe53db061",
"db_currency_id": "ad947477-1215-41bd-b9bb-e41a5b837700",
"db_language_id": "7c37e5bc-3e99-42e2-8e81-70f29fc1f7e5",
"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-12T13:20:40.9923968+00:00"
},
"modified_dateutc": "2026-09-12T13:20:40.9923968+00:00"
},
"equipment_model_id": "b86f740f-9343-47b1-8426-3e1630da80f8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "49bbc90a-443f-4fca-aa04-98138152190a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6589a025-fda2-4aae-9641-f198e5f4d818",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "41119ccc-2460-4ec6-9e45-b8e435600280",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7fbfbf0d-852a-438d-8763-55b2753c0a2a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "461cfa85-b39a-45bc-b4a5-cc2c0b13c27c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c57ad93e-ba68-4ef1-952b-33cfe53db061",
"db_currency_id": "ad947477-1215-41bd-b9bb-e41a5b837700",
"db_language_id": "7c37e5bc-3e99-42e2-8e81-70f29fc1f7e5",
"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-12T13:20:40.9923968+00:00"
},
"modified_dateutc": "2026-09-12T13:20:40.9923968+00:00"
},
"equipment_family_id": "8f38e73d-62b7-45ec-b5a6-a43c14043cf7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "fb04ef22-a38c-4b0e-9363-fb14366d2353",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8c1c19d7-e9ac-4445-99de-5f47e1c44837",
"_parent_code": "sample string 6",
"sales_organization_id": "a807c4c0-2dd1-4556-8abe-5eb3b59392aa",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "461cfa85-b39a-45bc-b4a5-cc2c0b13c27c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c57ad93e-ba68-4ef1-952b-33cfe53db061",
"db_currency_id": "ad947477-1215-41bd-b9bb-e41a5b837700",
"db_language_id": "7c37e5bc-3e99-42e2-8e81-70f29fc1f7e5",
"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-12T13:20:40.9923968+00:00"
},
"modified_dateutc": "2026-09-12T13:20:40.9923968+00:00"
},
"date_in_production_since": "2026-09-12T13:20:40.9923968+00:00",
"date_out_of_production_since": "2026-09-12T13:20:40.9923968+00:00",
"date_end_support": "2026-09-12T13:20:40.9923968+00:00",
"sales_organization_id": "3b4f6288-1214-4da5-a99e-ad73d4ee289c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "461cfa85-b39a-45bc-b4a5-cc2c0b13c27c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c57ad93e-ba68-4ef1-952b-33cfe53db061",
"db_currency_id": "ad947477-1215-41bd-b9bb-e41a5b837700",
"db_language_id": "7c37e5bc-3e99-42e2-8e81-70f29fc1f7e5",
"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-12T13:20:40.9923968+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-12T13:20:40.9923968+00:00"
},
"project_status_id": "c187bd61-1edc-4460-b1b6-9f5a3aaa4544",
"project_status_code": "sample string 10",
"project_status": {
"id": "06a1b0b6-cf3d-4f92-86a6-4ee9dff26274",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "807b8b95-2e0e-43a4-8dd5-1d326b02588c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "461cfa85-b39a-45bc-b4a5-cc2c0b13c27c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c57ad93e-ba68-4ef1-952b-33cfe53db061",
"db_currency_id": "ad947477-1215-41bd-b9bb-e41a5b837700",
"db_language_id": "7c37e5bc-3e99-42e2-8e81-70f29fc1f7e5",
"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-12T13:20:40.9923968+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-12T13:20:40.9923968+00:00"
},
"company_id": "cc737fef-8444-4482-a47e-fb307f028c11",
"company_code": "sample string 12",
"db_address_id": "6f252b0f-dfff-48e3-94d6-a7c2930ac62c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "61c0d38c-d3cf-4524-8f5d-75e9db455548",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a8ab97c9-5425-43b3-8936-7f2ea44a1954",
"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-12T13:20:40.9923968+00:00",
"date_create": "2026-09-12T13:20:40.9923968+00:00",
"date_update": "2026-09-12T13:20:40.9923968+00:00",
"updated_by_user_id": "92037464-c800-4f58-8a1e-cb671523bf3b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-12T13:20:40.9923968+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-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-12T13:20:40.9923968+00:00",
"date_last_job": "2026-09-12T13:20:40.9923968+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-12T13:20:40.9923968+00:00",
"modified_dateutc": "2026-09-12T13:20:40.9923968+00:00",
"is_mobile_installation": true
},
"job_type_id": "30046fd5-831d-43a6-8509-5b92bf6fa78e",
"job_type_code": "sample string 7",
"job_type": {
"id": "fdcec9e2-b445-4ddf-a0c9-f53638229046",
"name": "sample string 2",
"sales_organization_id": "4415512e-3798-4c4a-a8d5-39c52c8e2133",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-12T13:20:40.9923968+00:00",
"code": "sample string 7"
},
"job_priority_id": "b4a1b68a-6789-40f6-8af0-aeacb1455554",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3aa08ea7-3a52-451d-85a2-1aca92245dbb",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7ae961af-9517-4f4b-a88c-5e5c285e6301",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "461cfa85-b39a-45bc-b4a5-cc2c0b13c27c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c57ad93e-ba68-4ef1-952b-33cfe53db061",
"db_currency_id": "ad947477-1215-41bd-b9bb-e41a5b837700",
"db_language_id": "7c37e5bc-3e99-42e2-8e81-70f29fc1f7e5",
"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-12T13:20:40.9923968+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-12T13:20:40.9923968+00:00"
},
"job_status_id": "89f998e2-f8e1-4da7-8cdd-23e6f26fefa7",
"job_status_code": "sample string 11",
"db_address_id": "36ea1a1b-f592-4777-a07c-844e3f220878",
"contact_id": "b3a5b901-57fb-47ff-862c-f8f88f557925",
"requested_by_company_id": "aae6b9be-b7be-4147-9a88-d49c67e647ae",
"requested_by_contact_id": "48cefa02-eeb9-4d55-aaf9-79a76cf70a8c",
"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-12T13:20:40.9923968+00:00",
"due_date": "2026-09-12T13:20:40.9923968+00:00",
"date_create": "2026-09-12T13:20:40.9923968+00:00",
"date_update": "2026-09-12T13:20:40.9923968+00:00",
"date_closed": "2026-09-12T13:20:40.9923968+00:00",
"suggested_user_id": "a99bca37-7205-4b57-9715-b1631385a1f3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "dbb80702-7950-4d23-8083-783fe174dd55",
"db_language_id": "5f1199f5-b044-46af-9747-3151456b78d3",
"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-12T13:20:40.9923968+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "efb77659-7e55-4663-acaf-c0c42efeee8c",
"sales_organization": {
"id": "461cfa85-b39a-45bc-b4a5-cc2c0b13c27c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c57ad93e-ba68-4ef1-952b-33cfe53db061",
"db_currency_id": "ad947477-1215-41bd-b9bb-e41a5b837700",
"db_language_id": "7c37e5bc-3e99-42e2-8e81-70f29fc1f7e5",
"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-12T13:20:40.9923968+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f558b3d7-211b-4236-9f93-087d88eb3f6e",
"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": "35a3f6a0-7819-4696-afa3-0d75b62f3dc2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-12T13:20:40.9923968+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6d25561d-d435-4b63-a55c-f54de2b60b32"
},
"suggested_date_start": "2026-09-12T13:20:40.9923968+00:00",
"skill_id": "c7b97a26-dda9-4ca8-ab98-e97a92b02cf6",
"skill_code": "sample string 32",
"skill": {
"id": "c011e1ab-3017-49a3-b9ce-7c71a97f373a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7f4d01ac-ec94-4fc6-8f4e-ca33443fddac",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "461cfa85-b39a-45bc-b4a5-cc2c0b13c27c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c57ad93e-ba68-4ef1-952b-33cfe53db061",
"db_currency_id": "ad947477-1215-41bd-b9bb-e41a5b837700",
"db_language_id": "7c37e5bc-3e99-42e2-8e81-70f29fc1f7e5",
"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-12T13:20:40.9923968+00:00"
},
"modified_dateutc": "2026-09-12T13:20:40.9923968+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "503db0cd-ec99-4222-b532-551e99ec5396",
"date_reported_by_company": "2026-09-12T13:20:40.9923968+00:00",
"id2": 36,
"company_id": "d310d5a3-0cf7-402c-bd8c-d395eace9702",
"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": "d2a51958-8b4e-4234-884c-5416ccb8a618",
"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-12T13:20:40.9923968+00:00"
},
"work_instruction_details_id": "24923a68-f33e-4ce2-acd5-b426fc8167d7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b3e1b7db-6d65-4fb2-a2cc-5a6e5988a817",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d7b2982a-70ed-4a98-8620-d46f967ef57d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-12T13:20:40.9923968+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": "484d9be2-8dcc-4ebc-8380-b792aa64bbb8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-12T13:20:40.9923968+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.