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": "cb6af378-6d91-4b10-8323-8a7f7a7ab1ec",
"jobs_id": "a1dba6ad-944b-4aab-ba57-44d95fa11b77",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "62c8f4fc-a3a7-4e53-877f-a7b902be9d0b",
"_parent_id": "eb60b90a-dbbe-4cc4-a3fc-858ffe3438f1",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3e4e206a-cae2-4a56-aad1-ce7d48858fe2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b2f8ef42-58e3-4883-bd1c-83d9718c8fbc",
"_parent_id": "1d7d0bd5-78fe-4477-be9f-eb98f42e48f1",
"root_parent_id": "ef74159e-1f9a-4285-a51f-c7c5fe596ed7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "dbad695a-2def-41b9-8941-920f9d7d6a65",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4e5b34e3-d7e5-4f67-bf1b-32727720f981",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2a30f9ba-3751-48a0-b916-f44e6551b88e",
"_parent_code": "sample string 6",
"sales_organization_id": "72ea86d4-ba48-44a8-9f8d-cf6d3849812d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5704d5bf-72f2-4a85-8f69-a3690eea715f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f03d19a0-b784-4448-8bdb-7a9cdf2f7bc7",
"db_currency_id": "6490b429-d040-4e71-9674-65757417ac6b",
"db_language_id": "054afe92-85fe-463a-b005-f1e7f9bb62d6",
"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": "2025-11-30T09:10:50.2732752+00:00"
},
"modified_dateutc": "2025-11-30T09:10:50.2732752+00:00"
},
"equipment_model_id": "9819a87a-1603-4fb8-87eb-7285e7918ced",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "572e14ad-b3b1-4419-9274-14ad9f07bbec",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "74d6d812-45d4-40f5-98f4-793f9264f750",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2968ca0c-67ed-4156-99df-4c3bdd76906b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5ce1327b-18e6-4f57-ab0d-f6ba42374e3d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5704d5bf-72f2-4a85-8f69-a3690eea715f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f03d19a0-b784-4448-8bdb-7a9cdf2f7bc7",
"db_currency_id": "6490b429-d040-4e71-9674-65757417ac6b",
"db_language_id": "054afe92-85fe-463a-b005-f1e7f9bb62d6",
"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": "2025-11-30T09:10:50.2732752+00:00"
},
"modified_dateutc": "2025-11-30T09:10:50.2732752+00:00"
},
"equipment_family_id": "c5c296ff-9916-44f7-a5db-5d845d54723f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4e5b34e3-d7e5-4f67-bf1b-32727720f981",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2a30f9ba-3751-48a0-b916-f44e6551b88e",
"_parent_code": "sample string 6",
"sales_organization_id": "72ea86d4-ba48-44a8-9f8d-cf6d3849812d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5704d5bf-72f2-4a85-8f69-a3690eea715f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f03d19a0-b784-4448-8bdb-7a9cdf2f7bc7",
"db_currency_id": "6490b429-d040-4e71-9674-65757417ac6b",
"db_language_id": "054afe92-85fe-463a-b005-f1e7f9bb62d6",
"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": "2025-11-30T09:10:50.2732752+00:00"
},
"modified_dateutc": "2025-11-30T09:10:50.2732752+00:00"
},
"date_in_production_since": "2025-11-30T09:10:50.2732752+00:00",
"date_out_of_production_since": "2025-11-30T09:10:50.2732752+00:00",
"date_end_support": "2025-11-30T09:10:50.2732752+00:00",
"sales_organization_id": "86d1b269-5817-4ff8-9543-b748f706f9d8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5704d5bf-72f2-4a85-8f69-a3690eea715f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f03d19a0-b784-4448-8bdb-7a9cdf2f7bc7",
"db_currency_id": "6490b429-d040-4e71-9674-65757417ac6b",
"db_language_id": "054afe92-85fe-463a-b005-f1e7f9bb62d6",
"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": "2025-11-30T09:10:50.2732752+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": "2025-11-30T09:10:50.2732752+00:00"
},
"project_status_id": "e77e100e-e9b7-4323-9ea2-ed12f98e75d3",
"project_status_code": "sample string 10",
"project_status": {
"id": "d11925c9-96d7-43a8-97d0-75f73a750333",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "57ea0075-9e70-41a3-9a22-a8c9f8333d73",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5704d5bf-72f2-4a85-8f69-a3690eea715f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f03d19a0-b784-4448-8bdb-7a9cdf2f7bc7",
"db_currency_id": "6490b429-d040-4e71-9674-65757417ac6b",
"db_language_id": "054afe92-85fe-463a-b005-f1e7f9bb62d6",
"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": "2025-11-30T09:10:50.2732752+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-30T09:10:50.2732752+00:00"
},
"company_id": "c57e3193-29fd-4f4a-a2c5-3ed9b4886f56",
"company_code": "sample string 12",
"db_address_id": "63367ad9-07f4-4f8d-819e-c05d9a952467",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1b3b1b56-a886-4bb8-bd98-31f072b1c631",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ba8ddaf6-c153-4eb1-9b60-430a6ae23f9c",
"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": "2025-11-30T09:10:50.2732752+00:00",
"date_create": "2025-11-30T09:10:50.2732752+00:00",
"date_update": "2025-11-30T09:10:50.2732752+00:00",
"updated_by_user_id": "ceb21bec-b8e2-46a9-90b7-c12b3797de2b",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-30T09:10:50.2732752+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": "2025-11-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-30T09:10:50.2732752+00:00",
"date_last_job": "2025-11-30T09:10:50.2732752+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-30T09:10:50.2732752+00:00",
"modified_dateutc": "2025-11-30T09:10:50.2732752+00:00",
"is_mobile_installation": true
},
"job_type_id": "0eb27d38-33a4-4a3d-b522-7033e75c576a",
"job_type_code": "sample string 7",
"job_type": {
"id": "29957aef-a7af-4633-b41a-8886ddfa0524",
"name": "sample string 2",
"sales_organization_id": "97b07a43-dc1c-45c6-9582-0f7149169178",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-30T09:10:50.2732752+00:00",
"code": "sample string 7"
},
"job_priority_id": "01baa4d3-44d8-4742-bac3-fec90da88ed0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6aca7207-4792-439f-b2d9-4f5880e92d8c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "cf74a9a6-9af8-4200-86bc-74093f98f7e8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5704d5bf-72f2-4a85-8f69-a3690eea715f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f03d19a0-b784-4448-8bdb-7a9cdf2f7bc7",
"db_currency_id": "6490b429-d040-4e71-9674-65757417ac6b",
"db_language_id": "054afe92-85fe-463a-b005-f1e7f9bb62d6",
"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": "2025-11-30T09:10:50.2732752+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-30T09:10:50.2732752+00:00"
},
"job_status_id": "386f4f6c-4e36-4a00-987a-ecfe82da3b1d",
"job_status_code": "sample string 11",
"db_address_id": "22eb67b4-a135-4ca6-885b-7371f671bbdf",
"contact_id": "27262997-e049-41f2-a8e6-d896d69ab2fc",
"requested_by_company_id": "16caf74e-07f3-4a65-8482-13a56fc252e8",
"requested_by_contact_id": "6d04eb4e-06b2-4386-bc0c-d7e590c57320",
"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": "2025-11-30T09:10:50.2732752+00:00",
"due_date": "2025-11-30T09:10:50.2732752+00:00",
"date_create": "2025-11-30T09:10:50.2732752+00:00",
"date_update": "2025-11-30T09:10:50.2732752+00:00",
"date_closed": "2025-11-30T09:10:50.2732752+00:00",
"suggested_user_id": "1d6e4369-2aec-4318-9c19-12d8b206e124",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "cac5ee89-5b12-4939-90df-881f93bf5cc2",
"db_language_id": "71b7f301-7cea-4452-824b-1dcd21464166",
"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": "2025-11-30T09:10:50.2732752+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c5cf27c1-10ca-4d0c-bc3d-801eed0c80fa",
"sales_organization": {
"id": "5704d5bf-72f2-4a85-8f69-a3690eea715f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f03d19a0-b784-4448-8bdb-7a9cdf2f7bc7",
"db_currency_id": "6490b429-d040-4e71-9674-65757417ac6b",
"db_language_id": "054afe92-85fe-463a-b005-f1e7f9bb62d6",
"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": "2025-11-30T09:10:50.2732752+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "59bd1d20-ad3c-4538-8824-1c3cf976f74a",
"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": "6cdb6d37-643a-4ee4-931b-10dee788b8df",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-30T09:10:50.2732752+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "72df9d33-abb9-4f61-b0d3-9f22f1e17f7b"
},
"suggested_date_start": "2025-11-30T09:10:50.2732752+00:00",
"skill_id": "b4730b3a-b012-4ee7-a04f-3a9e9b7cb285",
"skill_code": "sample string 32",
"skill": {
"id": "21da7479-f65d-4caf-943b-07ac7df39eb1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b8deb807-f9fd-4bc5-995e-858dbb7a5678",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5704d5bf-72f2-4a85-8f69-a3690eea715f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f03d19a0-b784-4448-8bdb-7a9cdf2f7bc7",
"db_currency_id": "6490b429-d040-4e71-9674-65757417ac6b",
"db_language_id": "054afe92-85fe-463a-b005-f1e7f9bb62d6",
"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": "2025-11-30T09:10:50.2732752+00:00"
},
"modified_dateutc": "2025-11-30T09:10:50.2888987+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8aa021a7-0b0b-4c75-aeea-a7f03b2b36a2",
"date_reported_by_company": "2025-11-30T09:10:50.2888987+00:00",
"id2": 36,
"company_id": "16eb72ef-7971-4098-9bd0-1500cf090433",
"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": "065f0d15-b8c9-4c67-8d22-4e8f825052a5",
"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": "2025-11-30T09:10:50.2888987+00:00"
},
"work_instruction_details_id": "1267f38d-ff58-4e3d-b13c-7356bfaf14de",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1d2ad79e-2a70-4f13-b56c-82a9636b9520",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "56de5529-a345-4b05-9068-ce6c4e4ee641",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-30T09:10:50.2888987+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": "43a140ea-bc90-4368-b07f-92049f6b175c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-30T09:10:50.2888987+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.