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": "58032ae3-e249-45d0-8eec-66ab86fbe732",
"jobs_id": "c3820a8f-ffbe-4b3e-bca4-e25943acceae",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "eb12cd7f-8415-4a76-af05-15e64f2fa308",
"_parent_id": "622dfad4-9a4b-44f2-b532-d6515c3b3598",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "846503b4-2d04-4eac-b11a-f66112c87f04",
"project_reference_back_office": "sample string 5",
"project": {
"id": "885af27a-f6ca-4d25-8af4-6292c0f8ec7f",
"_parent_id": "c222ef45-db30-4a14-b2d2-e6756eccd19a",
"root_parent_id": "5801a58a-d61f-4f36-bcd7-3450474396b0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "98dbac83-6fad-434b-be90-f7eb3e74016d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "28e16878-6e4b-4dc4-aaca-438497d614a5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a082c272-ac9d-4b26-b048-413036062afa",
"_parent_code": "sample string 6",
"sales_organization_id": "5c024b58-c936-458b-831c-de09dd8f6809",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5b1dd612-87bc-44e4-af62-d5c0e2b8a9a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f719412-65a6-4cd0-a0b5-0076e14d455f",
"db_currency_id": "3002a949-d5ff-4dee-a6eb-d82cf015e9e6",
"db_language_id": "0b973884-431a-4923-9948-689a2eaeb10a",
"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-12-11T07:48:48.100216+00:00"
},
"modified_dateutc": "2025-12-11T07:48:48.100216+00:00"
},
"equipment_model_id": "0ddba444-4718-48fd-b4d4-b6bc00874661",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4d016745-2c65-4151-84a5-934ad2f37014",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a8f0f9de-7639-48f1-88ff-01c563e38056",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3f1ed6d5-4574-47b4-8330-8090d42a5b5c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "991291f3-1318-4c31-8b05-629000831940",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5b1dd612-87bc-44e4-af62-d5c0e2b8a9a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f719412-65a6-4cd0-a0b5-0076e14d455f",
"db_currency_id": "3002a949-d5ff-4dee-a6eb-d82cf015e9e6",
"db_language_id": "0b973884-431a-4923-9948-689a2eaeb10a",
"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-12-11T07:48:48.100216+00:00"
},
"modified_dateutc": "2025-12-11T07:48:48.100216+00:00"
},
"equipment_family_id": "a105a7e7-03a0-4ec3-b9ea-f417e51843eb",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "28e16878-6e4b-4dc4-aaca-438497d614a5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a082c272-ac9d-4b26-b048-413036062afa",
"_parent_code": "sample string 6",
"sales_organization_id": "5c024b58-c936-458b-831c-de09dd8f6809",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5b1dd612-87bc-44e4-af62-d5c0e2b8a9a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f719412-65a6-4cd0-a0b5-0076e14d455f",
"db_currency_id": "3002a949-d5ff-4dee-a6eb-d82cf015e9e6",
"db_language_id": "0b973884-431a-4923-9948-689a2eaeb10a",
"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-12-11T07:48:48.100216+00:00"
},
"modified_dateutc": "2025-12-11T07:48:48.100216+00:00"
},
"date_in_production_since": "2025-12-11T07:48:48.100216+00:00",
"date_out_of_production_since": "2025-12-11T07:48:48.100216+00:00",
"date_end_support": "2025-12-11T07:48:48.100216+00:00",
"sales_organization_id": "b010955a-9cb2-43c0-971b-54bef84310dc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5b1dd612-87bc-44e4-af62-d5c0e2b8a9a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f719412-65a6-4cd0-a0b5-0076e14d455f",
"db_currency_id": "3002a949-d5ff-4dee-a6eb-d82cf015e9e6",
"db_language_id": "0b973884-431a-4923-9948-689a2eaeb10a",
"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-12-11T07:48:48.100216+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-12-11T07:48:48.1158389+00:00"
},
"project_status_id": "f27993ce-3b13-4204-abaa-c4cb4dca7d63",
"project_status_code": "sample string 10",
"project_status": {
"id": "1c57cdc4-5b4a-4fde-a95e-4df6ea7e4ec3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a5989b97-5396-49e4-92c5-0d4072f80319",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5b1dd612-87bc-44e4-af62-d5c0e2b8a9a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f719412-65a6-4cd0-a0b5-0076e14d455f",
"db_currency_id": "3002a949-d5ff-4dee-a6eb-d82cf015e9e6",
"db_language_id": "0b973884-431a-4923-9948-689a2eaeb10a",
"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-12-11T07:48:48.100216+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-11T07:48:48.1158389+00:00"
},
"company_id": "d1ea777b-ae4a-480f-80fd-2b5230a0d070",
"company_code": "sample string 12",
"db_address_id": "d41c0e26-74d8-468c-a22a-026c98c22888",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4093f4c7-6b33-4488-9d49-0bfad38d2915",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1d4858b9-034f-4bb4-8f08-af7d9c44eb9c",
"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-12-11T07:48:48.1158389+00:00",
"date_create": "2025-12-11T07:48:48.1158389+00:00",
"date_update": "2025-12-11T07:48:48.1158389+00:00",
"updated_by_user_id": "85ef597c-35ab-4443-bbb9-d02bfddefa6b",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-11T07:48:48.1158389+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-12-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-11T07:48:48.1158389+00:00",
"date_last_job": "2025-12-11T07:48:48.1158389+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-11T07:48:48.1158389+00:00",
"modified_dateutc": "2025-12-11T07:48:48.1158389+00:00",
"is_mobile_installation": true
},
"job_type_id": "3ba75fc1-c9a4-40b7-8f5e-314fe5186091",
"job_type_code": "sample string 7",
"job_type": {
"id": "00c53378-8d1e-43de-9dec-1557eae6d9c5",
"name": "sample string 2",
"sales_organization_id": "5161510e-b567-4979-aa7d-2971c9f12381",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-11T07:48:48.1158389+00:00",
"code": "sample string 7"
},
"job_priority_id": "03240214-7e2e-4df3-854b-eac13641161f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "518ffc8d-fd7b-4bd1-a2c0-feb1eedc1bd2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8e275a30-68b3-4d17-9932-633173d8d644",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5b1dd612-87bc-44e4-af62-d5c0e2b8a9a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f719412-65a6-4cd0-a0b5-0076e14d455f",
"db_currency_id": "3002a949-d5ff-4dee-a6eb-d82cf015e9e6",
"db_language_id": "0b973884-431a-4923-9948-689a2eaeb10a",
"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-12-11T07:48:48.100216+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-11T07:48:48.1158389+00:00"
},
"job_status_id": "d8466c90-7ab5-4a8f-990a-6bc8cc34d966",
"job_status_code": "sample string 11",
"db_address_id": "80c26413-daf2-4688-91da-3ca028d513c6",
"contact_id": "3da05b63-22b7-40fe-846f-8ea001046d30",
"requested_by_company_id": "e1228330-765f-46fb-a8d2-c2400287d47a",
"requested_by_contact_id": "97f4775b-fe33-4bb1-b220-01ddaaac8b32",
"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-12-11T07:48:48.1158389+00:00",
"due_date": "2025-12-11T07:48:48.1158389+00:00",
"date_create": "2025-12-11T07:48:48.1158389+00:00",
"date_update": "2025-12-11T07:48:48.1158389+00:00",
"date_closed": "2025-12-11T07:48:48.1158389+00:00",
"suggested_user_id": "65c96d0d-557c-4415-b964-84e0784f6f11",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0087ecc0-27a3-4be0-aafd-6b21aba4c598",
"db_language_id": "de819487-0f18-4b84-a241-8492e4035075",
"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-12-11T07:48:48.1158389+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3cac89ee-e039-475b-ab2b-98229dfdec88",
"sales_organization": {
"id": "5b1dd612-87bc-44e4-af62-d5c0e2b8a9a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f719412-65a6-4cd0-a0b5-0076e14d455f",
"db_currency_id": "3002a949-d5ff-4dee-a6eb-d82cf015e9e6",
"db_language_id": "0b973884-431a-4923-9948-689a2eaeb10a",
"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-12-11T07:48:48.100216+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d3fc962d-9921-40c6-b828-7c4a0a3a59c6",
"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": "fac78a72-b4b6-47e3-a58b-428cfe7b5ff1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-11T07:48:48.1158389+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4af98ba3-5da5-4d8e-813e-2bacbdc91ed2"
},
"suggested_date_start": "2025-12-11T07:48:48.1158389+00:00",
"skill_id": "960b597c-ef4f-44af-98a6-aa94ff1ef66d",
"skill_code": "sample string 32",
"skill": {
"id": "8694daf2-f63e-4ef7-b122-161b30bcc7ca",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ef684b96-457a-44af-bac0-5633611d1627",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5b1dd612-87bc-44e4-af62-d5c0e2b8a9a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f719412-65a6-4cd0-a0b5-0076e14d455f",
"db_currency_id": "3002a949-d5ff-4dee-a6eb-d82cf015e9e6",
"db_language_id": "0b973884-431a-4923-9948-689a2eaeb10a",
"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-12-11T07:48:48.100216+00:00"
},
"modified_dateutc": "2025-12-11T07:48:48.1158389+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1102dd2e-ffe3-4350-ae2c-cee730565381",
"date_reported_by_company": "2025-12-11T07:48:48.1158389+00:00",
"id2": 36,
"company_id": "df00b63d-1e16-4095-b29f-69bb1c803b6e",
"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": "b8e3abc6-50a2-41f8-aa4d-e188ee4ae43d",
"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-12-11T07:48:48.1158389+00:00"
},
"work_instruction_details_id": "45e1dfa0-3379-402e-a649-bbcb8eb4e743",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e6be424e-b910-4f68-9f49-0607190d89ac",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3e5ba9c9-1da7-4693-a2a7-330edef32e9c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-11T07:48:48.1158389+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": "3ad73700-220e-45c4-befc-aeb3d59bdfbd",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-11T07:48:48.1158389+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.