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": "be7922ef-4bc9-41dc-b2ed-dec19da42892",
"jobs_id": "d7cf6ada-e47f-46c8-beb6-e92d008611db",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "71ec5ac4-ba70-4ac4-ac39-176cb25c6ead",
"_parent_id": "6daca901-9725-4f67-9779-cee496e79c46",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0696d970-d53a-40f1-847c-f9fbe4eb8c48",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0bb2fc1b-3816-410c-9bb8-43d5145db4a5",
"_parent_id": "c650ad66-e85a-4a92-8537-46f1cb1bafcc",
"root_parent_id": "27b2fbd0-1fb8-44d2-9ac3-bf4f6455f3c3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "abe13838-826b-4bbd-b211-f4e7c0b84665",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d588196c-d6f6-46a4-86cc-f7e3536b80bf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0d857404-a881-4fc4-b554-c8e4844a34d3",
"_parent_code": "sample string 6",
"sales_organization_id": "ba3792bc-d683-4130-ba04-12b999d66068",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cd26c455-c1d5-46fd-984e-1bfed58e0a6a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a86f0adc-bca0-4ecb-aa22-024728496935",
"db_currency_id": "5033d6cd-c8aa-4122-8a54-bbfbc3a29444",
"db_language_id": "7ffd1ccc-8ff1-453e-9025-6d582f09c90e",
"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-05-07T13:04:30.437744+00:00"
},
"modified_dateutc": "2026-05-07T13:04:30.437744+00:00"
},
"equipment_model_id": "0ad8cd9b-a4c7-4386-b0a0-819e2705d2e4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "36d81273-097f-468c-a263-12f0c35fd03c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "32d23399-a9ad-490f-a699-773017384c1d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a6dec402-7e8a-4f32-8ee7-8b3f9d5f556a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e4a4ebef-b2ff-4012-9ffc-4aa98013b13f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cd26c455-c1d5-46fd-984e-1bfed58e0a6a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a86f0adc-bca0-4ecb-aa22-024728496935",
"db_currency_id": "5033d6cd-c8aa-4122-8a54-bbfbc3a29444",
"db_language_id": "7ffd1ccc-8ff1-453e-9025-6d582f09c90e",
"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-05-07T13:04:30.437744+00:00"
},
"modified_dateutc": "2026-05-07T13:04:30.437744+00:00"
},
"equipment_family_id": "8a824d20-f3ce-4e1f-99f4-89e74d92fdfd",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d588196c-d6f6-46a4-86cc-f7e3536b80bf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0d857404-a881-4fc4-b554-c8e4844a34d3",
"_parent_code": "sample string 6",
"sales_organization_id": "ba3792bc-d683-4130-ba04-12b999d66068",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cd26c455-c1d5-46fd-984e-1bfed58e0a6a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a86f0adc-bca0-4ecb-aa22-024728496935",
"db_currency_id": "5033d6cd-c8aa-4122-8a54-bbfbc3a29444",
"db_language_id": "7ffd1ccc-8ff1-453e-9025-6d582f09c90e",
"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-05-07T13:04:30.437744+00:00"
},
"modified_dateutc": "2026-05-07T13:04:30.437744+00:00"
},
"date_in_production_since": "2026-05-07T13:04:30.437744+00:00",
"date_out_of_production_since": "2026-05-07T13:04:30.437744+00:00",
"date_end_support": "2026-05-07T13:04:30.437744+00:00",
"sales_organization_id": "23112d80-2673-4bec-89ea-04db9278cd71",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "cd26c455-c1d5-46fd-984e-1bfed58e0a6a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a86f0adc-bca0-4ecb-aa22-024728496935",
"db_currency_id": "5033d6cd-c8aa-4122-8a54-bbfbc3a29444",
"db_language_id": "7ffd1ccc-8ff1-453e-9025-6d582f09c90e",
"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-05-07T13:04:30.437744+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-05-07T13:04:30.437744+00:00"
},
"project_status_id": "dbd2a896-fdf2-4726-97f6-7ee6b89a6219",
"project_status_code": "sample string 10",
"project_status": {
"id": "f3dc5e27-549b-4a3a-a0d0-5971b07e11ac",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9e6335ad-8fac-4edd-8cbe-83a34b20341b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cd26c455-c1d5-46fd-984e-1bfed58e0a6a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a86f0adc-bca0-4ecb-aa22-024728496935",
"db_currency_id": "5033d6cd-c8aa-4122-8a54-bbfbc3a29444",
"db_language_id": "7ffd1ccc-8ff1-453e-9025-6d582f09c90e",
"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-05-07T13:04:30.437744+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-07T13:04:30.437744+00:00"
},
"company_id": "0df5520e-d02c-45a5-a043-4cb53dd3098a",
"company_code": "sample string 12",
"db_address_id": "1e0005c4-be79-4c8c-9645-293039e66bab",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6419fcc3-02a6-4551-b7c7-db8eab19761a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "da89363a-9026-4766-aba4-b4d2eec18693",
"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-05-07T13:04:30.437744+00:00",
"date_create": "2026-05-07T13:04:30.437744+00:00",
"date_update": "2026-05-07T13:04:30.437744+00:00",
"updated_by_user_id": "e50c99e7-d3b4-419c-90ea-ebb2f13647f5",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-07T13:04:30.437744+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-05-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-07T13:04:30.437744+00:00",
"date_last_job": "2026-05-07T13:04:30.437744+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-07T13:04:30.437744+00:00",
"modified_dateutc": "2026-05-07T13:04:30.437744+00:00",
"is_mobile_installation": true
},
"job_type_id": "77d12380-c2d5-4b7f-b237-77f7bb03f4ee",
"job_type_code": "sample string 7",
"job_type": {
"id": "bdab1d4c-7989-46dc-8d1a-37cb2e410d02",
"name": "sample string 2",
"sales_organization_id": "e7dbd02e-7b9e-431a-aeff-5bbc36daa785",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-07T13:04:30.437744+00:00",
"code": "sample string 7"
},
"job_priority_id": "4fc1176e-2add-416c-90ec-a90c6994295d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fb4cbd29-335b-4a31-93b6-a25ee9aa279e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "cb32d836-98d4-4be9-b0e1-fb0b8f6b800d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cd26c455-c1d5-46fd-984e-1bfed58e0a6a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a86f0adc-bca0-4ecb-aa22-024728496935",
"db_currency_id": "5033d6cd-c8aa-4122-8a54-bbfbc3a29444",
"db_language_id": "7ffd1ccc-8ff1-453e-9025-6d582f09c90e",
"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-05-07T13:04:30.437744+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-07T13:04:30.437744+00:00"
},
"job_status_id": "246453f5-4b39-4aa4-becb-3f2c76414481",
"job_status_code": "sample string 11",
"db_address_id": "27108539-af6c-49fb-b317-aabfc27c4a19",
"contact_id": "2a81eec2-da02-43de-a675-1c49badfda73",
"requested_by_company_id": "e8e6d489-f7fe-4572-be6f-fce0f268a895",
"requested_by_contact_id": "1c585ccf-bbd9-4f14-af59-61a9c4066c3a",
"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-05-07T13:04:30.437744+00:00",
"due_date": "2026-05-07T13:04:30.437744+00:00",
"date_create": "2026-05-07T13:04:30.437744+00:00",
"date_update": "2026-05-07T13:04:30.437744+00:00",
"date_closed": "2026-05-07T13:04:30.437744+00:00",
"suggested_user_id": "092f038a-283a-4824-a18c-20c3997ec7f7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ff8838d2-b542-4b66-87a6-53716e55bb55",
"db_language_id": "ae5ee1aa-076a-47e2-ad88-f48cb067f102",
"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-05-07T13:04:30.437744+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "01c15478-1207-425e-bdff-e803973cdfed",
"sales_organization": {
"id": "cd26c455-c1d5-46fd-984e-1bfed58e0a6a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a86f0adc-bca0-4ecb-aa22-024728496935",
"db_currency_id": "5033d6cd-c8aa-4122-8a54-bbfbc3a29444",
"db_language_id": "7ffd1ccc-8ff1-453e-9025-6d582f09c90e",
"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-05-07T13:04:30.437744+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "623904b6-4f3a-491a-8e59-704b76e2ffdc",
"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": "0737a3c3-726a-4d5f-ba56-6e7a537acbe3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-07T13:04:30.437744+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f922e3bd-ca7b-4f52-98bb-0229d75bed8f"
},
"suggested_date_start": "2026-05-07T13:04:30.437744+00:00",
"skill_id": "48778b14-f293-4166-8aff-eaf3a5746c61",
"skill_code": "sample string 32",
"skill": {
"id": "0d72bb7b-e4a1-4aa5-9a09-f9e0e74a9043",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c20e1b40-6405-4c76-92e0-d0ea10854846",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cd26c455-c1d5-46fd-984e-1bfed58e0a6a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a86f0adc-bca0-4ecb-aa22-024728496935",
"db_currency_id": "5033d6cd-c8aa-4122-8a54-bbfbc3a29444",
"db_language_id": "7ffd1ccc-8ff1-453e-9025-6d582f09c90e",
"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-05-07T13:04:30.437744+00:00"
},
"modified_dateutc": "2026-05-07T13:04:30.437744+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d8d2c990-1d87-4995-a5f8-621b95b849a8",
"date_reported_by_company": "2026-05-07T13:04:30.437744+00:00",
"id2": 36,
"company_id": "b8e1d89e-6640-4bc1-a71c-16f25adc533a",
"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": "601e899b-cc1e-4dee-a5ee-a69504395259",
"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-05-07T13:04:30.437744+00:00"
},
"work_instruction_details_id": "64a7f156-1c20-469f-b6e1-a824a0060073",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "56ff969d-4f70-4b8d-873f-f69b05fd18f4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3e9a3ff0-4381-4524-96e5-8ef852a5fa03",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-07T13:04:30.437744+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": "566b6670-cfe1-4d3a-9c69-f48998f614ec",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-07T13:04:30.437744+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.