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": "13b47b26-3a54-4a3b-a46c-5fc1ed15dd2c",
"jobs_id": "f91aed18-2c9e-4a82-abd5-3e07943f82be",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e5eb0e15-0db4-45f7-af3f-cb94738da352",
"_parent_id": "73e094d6-d0a3-4407-b379-85d0d73b111d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d84de57f-b100-42ad-b336-1ee92e7a7bd9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "cb2041cd-3085-4c1f-a818-21bd39b64c1d",
"_parent_id": "2f424b97-5d38-4dd1-b4c1-f5ebc820e614",
"root_parent_id": "79d3a664-2964-45d3-9993-615095beba48",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "09940773-e9f5-421c-bb8d-1822afbb0fbf",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f6293126-aed1-428b-afa7-16361c489e58",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c10a8ae7-4341-4705-9888-b9a8ba82f667",
"_parent_code": "sample string 6",
"sales_organization_id": "f4b4b9a0-9a0e-4b1c-8fca-1ba59d76d428",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9870a02c-b1f2-44b0-9811-71ab12189369",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c3cae7e-ed7a-4378-a909-96ec6c7f432f",
"db_currency_id": "7c5c6ad6-d2bb-4dee-9973-923e5813beb9",
"db_language_id": "40de6a59-bebd-4a0d-80ff-b91a4deb5c99",
"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-27T07:10:57.9729671+00:00"
},
"modified_dateutc": "2025-11-27T07:10:57.9729671+00:00"
},
"equipment_model_id": "e18c8027-b298-4d0f-9186-c63bf37cc4fc",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "84e0cbde-e22d-4423-8bd4-7b29db24044d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4ee88661-85a3-49c3-8e30-b5522afd07c6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "14c33a86-d291-40c5-a426-496eb7441030",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "bd7dfdcb-433b-4b98-98b2-f25419aa4039",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9870a02c-b1f2-44b0-9811-71ab12189369",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c3cae7e-ed7a-4378-a909-96ec6c7f432f",
"db_currency_id": "7c5c6ad6-d2bb-4dee-9973-923e5813beb9",
"db_language_id": "40de6a59-bebd-4a0d-80ff-b91a4deb5c99",
"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-27T07:10:57.9729671+00:00"
},
"modified_dateutc": "2025-11-27T07:10:57.9729671+00:00"
},
"equipment_family_id": "826c0484-a262-4eaa-bd09-bdd8195a85b1",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f6293126-aed1-428b-afa7-16361c489e58",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c10a8ae7-4341-4705-9888-b9a8ba82f667",
"_parent_code": "sample string 6",
"sales_organization_id": "f4b4b9a0-9a0e-4b1c-8fca-1ba59d76d428",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9870a02c-b1f2-44b0-9811-71ab12189369",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c3cae7e-ed7a-4378-a909-96ec6c7f432f",
"db_currency_id": "7c5c6ad6-d2bb-4dee-9973-923e5813beb9",
"db_language_id": "40de6a59-bebd-4a0d-80ff-b91a4deb5c99",
"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-27T07:10:57.9729671+00:00"
},
"modified_dateutc": "2025-11-27T07:10:57.9729671+00:00"
},
"date_in_production_since": "2025-11-27T07:10:57.9729671+00:00",
"date_out_of_production_since": "2025-11-27T07:10:57.9729671+00:00",
"date_end_support": "2025-11-27T07:10:57.9729671+00:00",
"sales_organization_id": "672f5c6e-de97-47ba-806e-e9e65f5e7b2b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9870a02c-b1f2-44b0-9811-71ab12189369",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c3cae7e-ed7a-4378-a909-96ec6c7f432f",
"db_currency_id": "7c5c6ad6-d2bb-4dee-9973-923e5813beb9",
"db_language_id": "40de6a59-bebd-4a0d-80ff-b91a4deb5c99",
"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-27T07:10:57.9729671+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-27T07:10:57.9729671+00:00"
},
"project_status_id": "655d5643-51aa-4431-93ad-03bd46d17d8c",
"project_status_code": "sample string 10",
"project_status": {
"id": "e50d8075-215c-460c-bb71-8052d0696bb1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ad0c5486-f40f-4188-a6d7-ef5d6cb60602",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9870a02c-b1f2-44b0-9811-71ab12189369",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c3cae7e-ed7a-4378-a909-96ec6c7f432f",
"db_currency_id": "7c5c6ad6-d2bb-4dee-9973-923e5813beb9",
"db_language_id": "40de6a59-bebd-4a0d-80ff-b91a4deb5c99",
"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-27T07:10:57.9729671+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-27T07:10:57.9729671+00:00"
},
"company_id": "b599b24a-6e3b-4ffe-a8a8-4e3e04e1874c",
"company_code": "sample string 12",
"db_address_id": "5a2c2fd2-4782-4b40-b1c8-9af4100ae876",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e41ef16d-6247-4543-8a34-bc64fee04704",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "199ac434-e738-4563-ad2d-42e159cf8616",
"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-27T07:10:57.9729671+00:00",
"date_create": "2025-11-27T07:10:57.9729671+00:00",
"date_update": "2025-11-27T07:10:57.9729671+00:00",
"updated_by_user_id": "6002c373-0788-4e03-8d91-08877ab54777",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-27T07:10:57.9729671+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-27T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-27T07:10:57.9729671+00:00",
"date_last_job": "2025-11-27T07:10:57.9729671+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-27T07:10:57.9729671+00:00",
"modified_dateutc": "2025-11-27T07:10:57.9729671+00:00",
"is_mobile_installation": true
},
"job_type_id": "2d8b4cda-dd7d-4b9a-8f46-a79b57a2efef",
"job_type_code": "sample string 7",
"job_type": {
"id": "9ddb31c7-fd7c-41d0-a68e-b71515603b4b",
"name": "sample string 2",
"sales_organization_id": "01b8e9e3-1519-475f-ab96-64626eba9110",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-27T07:10:57.9729671+00:00",
"code": "sample string 7"
},
"job_priority_id": "a02e11e1-1156-4122-b941-cf1216628b05",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6aa38440-689f-469c-8a04-8f8e069b61fc",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3fcda2aa-c630-4a29-a84a-c4a7e03416ab",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9870a02c-b1f2-44b0-9811-71ab12189369",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c3cae7e-ed7a-4378-a909-96ec6c7f432f",
"db_currency_id": "7c5c6ad6-d2bb-4dee-9973-923e5813beb9",
"db_language_id": "40de6a59-bebd-4a0d-80ff-b91a4deb5c99",
"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-27T07:10:57.9729671+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-27T07:10:57.9729671+00:00"
},
"job_status_id": "a5adba04-9d7f-4311-aae1-255b89666f26",
"job_status_code": "sample string 11",
"db_address_id": "56b62f20-5835-4c0b-afe1-0a67dfb2cc14",
"contact_id": "eaff69a7-db6d-4d15-9221-0bf3d97cea55",
"requested_by_company_id": "cba8bccf-05c0-4c9a-a2b5-75546916142a",
"requested_by_contact_id": "02d92faa-baea-4e83-99de-9ee5fdb06e31",
"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-27T07:10:57.9729671+00:00",
"due_date": "2025-11-27T07:10:57.9729671+00:00",
"date_create": "2025-11-27T07:10:57.9729671+00:00",
"date_update": "2025-11-27T07:10:57.9729671+00:00",
"date_closed": "2025-11-27T07:10:57.9729671+00:00",
"suggested_user_id": "9d14116e-3208-46db-b70c-0bee79a8ac57",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6642099f-f159-4b5f-bf75-cf5dcf3ff215",
"db_language_id": "72ff871a-b4d9-4883-8f8b-f7823159f58a",
"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-27T07:10:57.9729671+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8bc01bd5-eacf-4ab9-86ac-9389c2fcae5c",
"sales_organization": {
"id": "9870a02c-b1f2-44b0-9811-71ab12189369",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c3cae7e-ed7a-4378-a909-96ec6c7f432f",
"db_currency_id": "7c5c6ad6-d2bb-4dee-9973-923e5813beb9",
"db_language_id": "40de6a59-bebd-4a0d-80ff-b91a4deb5c99",
"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-27T07:10:57.9729671+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "cabc3a3d-4ae3-4834-a243-b17171aec5f1",
"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": "d1b6330f-aad9-499f-8382-71dd3b30ad0c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-27T07:10:57.9729671+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "34e0ec29-8d00-4dd4-a320-40a531c00962"
},
"suggested_date_start": "2025-11-27T07:10:57.9729671+00:00",
"skill_id": "32ec8e9b-6ab3-4cdf-bea0-fd48766fba1d",
"skill_code": "sample string 32",
"skill": {
"id": "68a919e7-332c-4136-9b65-b10f0598a386",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "30252f0e-edc5-493b-848d-cf0c06bd8fef",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9870a02c-b1f2-44b0-9811-71ab12189369",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c3cae7e-ed7a-4378-a909-96ec6c7f432f",
"db_currency_id": "7c5c6ad6-d2bb-4dee-9973-923e5813beb9",
"db_language_id": "40de6a59-bebd-4a0d-80ff-b91a4deb5c99",
"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-27T07:10:57.9729671+00:00"
},
"modified_dateutc": "2025-11-27T07:10:57.9729671+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "83d93ac5-bd98-4b23-8941-6885e9463af0",
"date_reported_by_company": "2025-11-27T07:10:57.9729671+00:00",
"id2": 36,
"company_id": "78dff603-ec0b-48c9-b856-a7e0f384075e",
"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": "4752354d-4b51-42ad-a8e8-10cae3c4d75f",
"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-27T07:10:57.9729671+00:00"
},
"work_instruction_details_id": "18b3a02e-2bf6-4570-96f4-a03c0d2e3a77",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f2c859ee-ef37-4851-b8d0-9532be9e6a7f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3ec7b906-b46e-433e-bd9e-67fa97c58692",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-27T07:10:57.9729671+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": "33e86c85-3300-4edb-bbc4-6f4b82cc8de8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-27T07:10:57.9729671+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.