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": "a42b6176-a954-429a-b87c-fa190143b047",
"jobs_id": "d4c2c6a9-8af9-499a-b3dc-5b14211b070f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "432cd350-0b53-4913-b5d3-6591a10ccf4d",
"_parent_id": "58926bd0-0055-4676-83fc-0372529eea72",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3e11c158-8d6e-40c7-96f0-d15922e9b8a9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d499b861-7f45-4251-9633-7554dda424ce",
"_parent_id": "539ebcd9-33a1-4f66-a562-6b9cd2d7c18a",
"root_parent_id": "8dc47d26-a3da-4470-9a4f-24a5d632d0bf",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fdd89400-1dd5-4853-b1c6-08214b8226fc",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "47a4421a-03f5-4478-a6f7-b91b56209d48",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a86a1e3e-8eae-40ad-a3ca-aab80573a30b",
"_parent_code": "sample string 6",
"sales_organization_id": "4a8fb02a-8b48-497d-98f0-62a1819d725c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9b5eb0c7-0077-43ab-8290-e858925f2a75",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7314ccbf-9236-48c6-890f-6680c1033baa",
"db_currency_id": "0e62a9f0-1e38-44e9-a5b2-13275996e965",
"db_language_id": "1b70c50f-40de-4433-96ba-020d429dcbef",
"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-10-21T06:19:37.1351312+00:00"
},
"modified_dateutc": "2026-10-21T06:19:37.1351312+00:00"
},
"equipment_model_id": "c83e71dc-9264-4459-8dca-815561897069",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "932356c5-4a68-4709-aa10-81dbd91e0281",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e6191dc9-0767-483a-add6-8cf2cfadae3b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "acc4e6ea-1087-4b90-ad3c-ed367b0b67f9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6483acdf-bf1c-4657-be84-f1a6e79ecf84",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9b5eb0c7-0077-43ab-8290-e858925f2a75",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7314ccbf-9236-48c6-890f-6680c1033baa",
"db_currency_id": "0e62a9f0-1e38-44e9-a5b2-13275996e965",
"db_language_id": "1b70c50f-40de-4433-96ba-020d429dcbef",
"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-10-21T06:19:37.1351312+00:00"
},
"modified_dateutc": "2026-10-21T06:19:37.1351312+00:00"
},
"equipment_family_id": "a242aeb3-6931-4c3f-851d-0093b36ff233",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "47a4421a-03f5-4478-a6f7-b91b56209d48",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a86a1e3e-8eae-40ad-a3ca-aab80573a30b",
"_parent_code": "sample string 6",
"sales_organization_id": "4a8fb02a-8b48-497d-98f0-62a1819d725c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9b5eb0c7-0077-43ab-8290-e858925f2a75",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7314ccbf-9236-48c6-890f-6680c1033baa",
"db_currency_id": "0e62a9f0-1e38-44e9-a5b2-13275996e965",
"db_language_id": "1b70c50f-40de-4433-96ba-020d429dcbef",
"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-10-21T06:19:37.1351312+00:00"
},
"modified_dateutc": "2026-10-21T06:19:37.1351312+00:00"
},
"date_in_production_since": "2026-10-21T06:19:37.1351312+00:00",
"date_out_of_production_since": "2026-10-21T06:19:37.1351312+00:00",
"date_end_support": "2026-10-21T06:19:37.1351312+00:00",
"sales_organization_id": "ab3bad5c-b556-4c99-8d93-ff10ff946190",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9b5eb0c7-0077-43ab-8290-e858925f2a75",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7314ccbf-9236-48c6-890f-6680c1033baa",
"db_currency_id": "0e62a9f0-1e38-44e9-a5b2-13275996e965",
"db_language_id": "1b70c50f-40de-4433-96ba-020d429dcbef",
"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-10-21T06:19:37.1351312+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-10-21T06:19:37.1351312+00:00"
},
"project_status_id": "c5bacbbf-16fa-45a7-9f61-886a3af63463",
"project_status_code": "sample string 10",
"project_status": {
"id": "c176e4fe-eb44-41a8-8316-0efb2f18fe59",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3fbd1db8-8277-4b52-8d1d-e8b94f110709",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9b5eb0c7-0077-43ab-8290-e858925f2a75",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7314ccbf-9236-48c6-890f-6680c1033baa",
"db_currency_id": "0e62a9f0-1e38-44e9-a5b2-13275996e965",
"db_language_id": "1b70c50f-40de-4433-96ba-020d429dcbef",
"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-10-21T06:19:37.1351312+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-21T06:19:37.1351312+00:00"
},
"company_id": "59f454ea-7152-4678-9be2-3c4ebc2c6480",
"company_code": "sample string 12",
"db_address_id": "b1271329-02e8-496e-b220-0f73edb85d05",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "11276780-3ca6-425f-9317-57c8447e5772",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0affc699-1157-4075-91d3-de650bdc7a00",
"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-10-21T06:19:37.1351312+00:00",
"date_create": "2026-10-21T06:19:37.1351312+00:00",
"date_update": "2026-10-21T06:19:37.1351312+00:00",
"updated_by_user_id": "7b7948b1-0a11-4ee6-a70a-18da8527729b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-21T06:19:37.1351312+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-10-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-21T06:19:37.1351312+00:00",
"date_last_job": "2026-10-21T06:19:37.1351312+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-21T06:19:37.1351312+00:00",
"modified_dateutc": "2026-10-21T06:19:37.1351312+00:00",
"is_mobile_installation": true
},
"job_type_id": "ea59232b-3950-4699-9358-44c8374c97bc",
"job_type_code": "sample string 7",
"job_type": {
"id": "1bdf0928-e04e-46d2-bd16-0ca12cee1e12",
"name": "sample string 2",
"sales_organization_id": "cfe994c9-46e5-46bb-a8ba-b0c640594847",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-21T06:19:37.1351312+00:00",
"code": "sample string 7"
},
"job_priority_id": "d7421898-bc95-4fab-a39a-a0dfcbf8ebb8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "06598b02-7534-4200-ba63-b7319fb99b07",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "79714a5f-ae41-4729-9a36-8fa66c528600",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9b5eb0c7-0077-43ab-8290-e858925f2a75",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7314ccbf-9236-48c6-890f-6680c1033baa",
"db_currency_id": "0e62a9f0-1e38-44e9-a5b2-13275996e965",
"db_language_id": "1b70c50f-40de-4433-96ba-020d429dcbef",
"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-10-21T06:19:37.1351312+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-21T06:19:37.1351312+00:00"
},
"job_status_id": "5ce2937f-a23e-43f0-adc4-343425bd6d53",
"job_status_code": "sample string 11",
"db_address_id": "6197e494-4810-47b2-b7ad-14d3a5ff00d6",
"contact_id": "1cc61b9f-2bb1-457a-8f48-48819ec60a5b",
"requested_by_company_id": "d25de1c5-7e39-4855-8440-324a98ae3ebb",
"requested_by_contact_id": "83bc97dd-5db0-49dc-9ed3-06927f989ce9",
"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-10-21T06:19:37.1351312+00:00",
"due_date": "2026-10-21T06:19:37.1351312+00:00",
"date_create": "2026-10-21T06:19:37.1351312+00:00",
"date_update": "2026-10-21T06:19:37.1351312+00:00",
"date_closed": "2026-10-21T06:19:37.1351312+00:00",
"suggested_user_id": "be122aa6-4204-40c2-9d77-e90b4746f40f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6ed09901-7c2e-4f19-ab07-3821e52437cd",
"db_language_id": "5a5c9012-3a11-4212-b534-2349b96d21c7",
"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-10-21T06:19:37.1351312+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0206d0df-7db1-4393-9530-e4d6c18d067d",
"sales_organization": {
"id": "9b5eb0c7-0077-43ab-8290-e858925f2a75",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7314ccbf-9236-48c6-890f-6680c1033baa",
"db_currency_id": "0e62a9f0-1e38-44e9-a5b2-13275996e965",
"db_language_id": "1b70c50f-40de-4433-96ba-020d429dcbef",
"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-10-21T06:19:37.1351312+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "87d10085-cf34-4035-92ea-f9b006f15cec",
"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": "e2e64326-9646-4464-8a37-1f0520f33f66",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-21T06:19:37.1462963+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "77a986b6-b383-44fe-bd73-7b73a6d3aa59"
},
"suggested_date_start": "2026-10-21T06:19:37.1462963+00:00",
"skill_id": "a922dd11-5c51-4d78-9ade-ad697ccefa7a",
"skill_code": "sample string 32",
"skill": {
"id": "cf71eb09-ec77-4f61-8d55-3bcb8c97b06e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "998365c2-1836-45cf-a7cd-f0b7e1ffcc8e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9b5eb0c7-0077-43ab-8290-e858925f2a75",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7314ccbf-9236-48c6-890f-6680c1033baa",
"db_currency_id": "0e62a9f0-1e38-44e9-a5b2-13275996e965",
"db_language_id": "1b70c50f-40de-4433-96ba-020d429dcbef",
"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-10-21T06:19:37.1351312+00:00"
},
"modified_dateutc": "2026-10-21T06:19:37.1462963+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6960fa98-b019-4291-8f86-408db7dd36cf",
"date_reported_by_company": "2026-10-21T06:19:37.1462963+00:00",
"id2": 36,
"company_id": "a3f37a98-1fd6-4d50-a295-9c636c33e64d",
"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": "928721db-a6e9-40e8-aef4-c63efe1142bc",
"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-10-21T06:19:37.1462963+00:00"
},
"work_instruction_details_id": "f616afb8-f17f-4c03-808c-e775a0367c03",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "87b955c1-9ad2-4ba9-8fdd-abb0e9727965",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b0bea3a1-bb75-4d6c-ba4a-c3ecae2446dd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-21T06:19:37.1462963+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": "28c4ccc2-382c-4fd6-8217-1bb97c564d27",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-21T06:19:37.1462963+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.