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": "b0cdc560-eeb2-4b0e-824d-6ccbf26f0a61",
"jobs_id": "d91dec39-84ee-4e1f-84d6-52edfb716215",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "443bcb4c-6a5c-4e6b-b0af-43b3e1059b08",
"_parent_id": "f5a85354-74b2-496a-b78f-1a18d94c8f4a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a1542379-61de-4f5d-b7d3-2aa899b72e13",
"project_reference_back_office": "sample string 5",
"project": {
"id": "547ad7b9-877b-4285-9f14-1d34e427ce49",
"_parent_id": "dae02dab-37b0-4cd9-9fae-6ffb7d66abf6",
"root_parent_id": "6e862beb-4fbc-4c62-a1a0-ccbc03dc41db",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "68c043d3-7bcf-4e74-86b0-3b3440e5ce28",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "005a0e22-da78-4478-b494-8580731847c1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "74a0cb20-c142-48c0-9217-9ec3be3eb0a7",
"_parent_code": "sample string 6",
"sales_organization_id": "337f5af7-b184-4cad-9464-2a55e74bd225",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c06d8094-0e3c-4a64-80ce-f153a8536d6d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "550a7405-2b3f-4e11-ae3a-28d3d28016ae",
"db_currency_id": "e2b41428-3580-4686-9ad0-93c6f6274970",
"db_language_id": "30b35267-ac52-4f72-bbf1-173cb705b9ef",
"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-09-30T05:46:09.9434625+00:00"
},
"modified_dateutc": "2026-09-30T05:46:09.9434625+00:00"
},
"equipment_model_id": "f4c05664-11d4-4a72-b9a7-f1b1d571d212",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "308336c9-c13b-4061-99aa-3f9c441d09eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9fbe88d7-096a-4c5d-85bb-c7233d3bc88e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c061c49b-1816-4585-b21a-f86270242129",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "328d304f-f48d-4bf8-a54c-3c4e42681b64",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c06d8094-0e3c-4a64-80ce-f153a8536d6d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "550a7405-2b3f-4e11-ae3a-28d3d28016ae",
"db_currency_id": "e2b41428-3580-4686-9ad0-93c6f6274970",
"db_language_id": "30b35267-ac52-4f72-bbf1-173cb705b9ef",
"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-09-30T05:46:09.9434625+00:00"
},
"modified_dateutc": "2026-09-30T05:46:09.9434625+00:00"
},
"equipment_family_id": "10a564a9-b674-4ac3-83c9-600c274b19a2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "005a0e22-da78-4478-b494-8580731847c1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "74a0cb20-c142-48c0-9217-9ec3be3eb0a7",
"_parent_code": "sample string 6",
"sales_organization_id": "337f5af7-b184-4cad-9464-2a55e74bd225",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c06d8094-0e3c-4a64-80ce-f153a8536d6d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "550a7405-2b3f-4e11-ae3a-28d3d28016ae",
"db_currency_id": "e2b41428-3580-4686-9ad0-93c6f6274970",
"db_language_id": "30b35267-ac52-4f72-bbf1-173cb705b9ef",
"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-09-30T05:46:09.9434625+00:00"
},
"modified_dateutc": "2026-09-30T05:46:09.9434625+00:00"
},
"date_in_production_since": "2026-09-30T05:46:09.9434625+00:00",
"date_out_of_production_since": "2026-09-30T05:46:09.9434625+00:00",
"date_end_support": "2026-09-30T05:46:09.9434625+00:00",
"sales_organization_id": "28903c49-345b-4a3d-b64b-23e8bda0b1b6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c06d8094-0e3c-4a64-80ce-f153a8536d6d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "550a7405-2b3f-4e11-ae3a-28d3d28016ae",
"db_currency_id": "e2b41428-3580-4686-9ad0-93c6f6274970",
"db_language_id": "30b35267-ac52-4f72-bbf1-173cb705b9ef",
"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-09-30T05:46:09.9434625+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-09-30T05:46:09.9434625+00:00"
},
"project_status_id": "bb013509-663b-4194-bafe-62a62f012672",
"project_status_code": "sample string 10",
"project_status": {
"id": "5ccd160a-3da3-4fec-b609-657fceb08bdd",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d6405e93-12db-44d0-a557-de31f47c7ee8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c06d8094-0e3c-4a64-80ce-f153a8536d6d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "550a7405-2b3f-4e11-ae3a-28d3d28016ae",
"db_currency_id": "e2b41428-3580-4686-9ad0-93c6f6274970",
"db_language_id": "30b35267-ac52-4f72-bbf1-173cb705b9ef",
"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-09-30T05:46:09.9434625+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-30T05:46:09.9434625+00:00"
},
"company_id": "1aa13126-d2ad-4f2b-92cc-4fa13db7ed9a",
"company_code": "sample string 12",
"db_address_id": "4225a16f-f5a2-4f37-b182-6a6877eb3928",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "bebff121-5380-49ae-be7d-32d190b27426",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "28ae1916-318b-43cf-9257-06a786cd6878",
"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-09-30T05:46:09.9609704+00:00",
"date_create": "2026-09-30T05:46:09.9609704+00:00",
"date_update": "2026-09-30T05:46:09.9609704+00:00",
"updated_by_user_id": "8f65bbce-13a6-47e2-a86f-7a752ff4ea6b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-30T05:46:09.9609704+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-09-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-30T05:46:09.9609704+00:00",
"date_last_job": "2026-09-30T05:46:09.9609704+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-30T05:46:09.9609704+00:00",
"modified_dateutc": "2026-09-30T05:46:09.9609704+00:00",
"is_mobile_installation": true
},
"job_type_id": "c24f8357-15d4-47e2-ab64-ba630a3d7414",
"job_type_code": "sample string 7",
"job_type": {
"id": "23098b4d-8942-4fe7-867d-697e85fd6aa9",
"name": "sample string 2",
"sales_organization_id": "463b0ad4-76d6-4bc2-8db0-8ec29c83fca8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-30T05:46:09.9609704+00:00",
"code": "sample string 7"
},
"job_priority_id": "790cc41f-6110-44dd-8bb8-e845508a3494",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "deba422e-81f2-4c30-a313-de8b2afca69a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "accfd2ac-34cf-49d4-82fb-fa57a03282b1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c06d8094-0e3c-4a64-80ce-f153a8536d6d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "550a7405-2b3f-4e11-ae3a-28d3d28016ae",
"db_currency_id": "e2b41428-3580-4686-9ad0-93c6f6274970",
"db_language_id": "30b35267-ac52-4f72-bbf1-173cb705b9ef",
"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-09-30T05:46:09.9434625+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-30T05:46:09.9609704+00:00"
},
"job_status_id": "26b80140-8746-46c5-af0e-cf94e7cb44dd",
"job_status_code": "sample string 11",
"db_address_id": "554d1a7d-b6a6-4e4a-93d4-be979b89eb73",
"contact_id": "e10c8984-7bbb-4a2f-878c-551d5803177d",
"requested_by_company_id": "c50c8cdd-61c9-4c5d-bf31-990efa177620",
"requested_by_contact_id": "353c4e08-3aff-465d-af36-8eea29d98d47",
"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-09-30T05:46:09.9609704+00:00",
"due_date": "2026-09-30T05:46:09.9609704+00:00",
"date_create": "2026-09-30T05:46:09.9609704+00:00",
"date_update": "2026-09-30T05:46:09.9609704+00:00",
"date_closed": "2026-09-30T05:46:09.9609704+00:00",
"suggested_user_id": "8875fc2b-61c9-40fc-8024-ed780457788a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "09053e56-172d-4233-8f03-d697406c8d1d",
"db_language_id": "f4772754-157e-4ce1-8e28-0a79e19d50c4",
"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-09-30T05:46:09.9609704+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e886f5f2-bf44-4d3c-b82e-25ee9f576911",
"sales_organization": {
"id": "c06d8094-0e3c-4a64-80ce-f153a8536d6d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "550a7405-2b3f-4e11-ae3a-28d3d28016ae",
"db_currency_id": "e2b41428-3580-4686-9ad0-93c6f6274970",
"db_language_id": "30b35267-ac52-4f72-bbf1-173cb705b9ef",
"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-09-30T05:46:09.9434625+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "fd0e62d8-6ac2-41de-a867-f8f0233ed7e5",
"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": "3204b41b-ba1e-4d06-8d2a-89dd7a784682",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-30T05:46:09.9609704+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1e76db21-0707-4f34-9444-2ffb3b146d62"
},
"suggested_date_start": "2026-09-30T05:46:09.9609704+00:00",
"skill_id": "a80a02a6-88df-41c6-bfb6-4b2a3eb4d26a",
"skill_code": "sample string 32",
"skill": {
"id": "b5ba2c89-709b-4fea-a771-7d2238b39227",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ef016590-36a2-4230-9cfc-9ae8c6ce1cd8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c06d8094-0e3c-4a64-80ce-f153a8536d6d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "550a7405-2b3f-4e11-ae3a-28d3d28016ae",
"db_currency_id": "e2b41428-3580-4686-9ad0-93c6f6274970",
"db_language_id": "30b35267-ac52-4f72-bbf1-173cb705b9ef",
"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-09-30T05:46:09.9434625+00:00"
},
"modified_dateutc": "2026-09-30T05:46:09.9609704+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "63ae82d5-2916-40dc-815d-abed33d74dc5",
"date_reported_by_company": "2026-09-30T05:46:09.9609704+00:00",
"id2": 36,
"company_id": "9dc76a38-b4af-48db-b42c-4352a8b5843c",
"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": "22574c79-dc32-4289-974a-3993cdf0b7c9",
"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-09-30T05:46:09.9609704+00:00"
},
"work_instruction_details_id": "104ac09d-cb08-47f4-8faa-30fb62d0f707",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ae1d0f2d-6a8d-4252-a3fa-73ffa8f6218b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "fabe8b0f-5a1a-4bb1-93b9-0a92b74eb612",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-30T05:46:09.9609704+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": "d51fffd5-f221-453e-a9af-300cd57a54d9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-30T05:46:09.9609704+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.