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": "d18c9981-ac4f-442d-a06f-63da09eefc87",
"jobs_id": "99336a84-e26e-4e9f-b15b-419319b84d54",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "562d5280-2184-4f7b-81aa-4c168bcc12ef",
"_parent_id": "e8556906-6fb6-4c2a-9342-12e13550f265",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c5411420-7293-4255-a37d-7dcfad9e2f2b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "96258708-a569-4095-b20a-76c4fe471051",
"_parent_id": "bac7279c-b11a-457e-8900-18db16b46232",
"root_parent_id": "c2720432-5d77-4a8d-86c8-3f8fec7666cd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3bc4b9cb-8e63-4dbb-8685-9a3d19b43922",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e033b02c-8eb5-4832-a552-aafb83dd188d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ae2470d3-7a83-4b8f-89d9-d4882dce0460",
"_parent_code": "sample string 6",
"sales_organization_id": "5db30017-9054-4259-a2e7-436445730785",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b5c626c3-f79d-46a5-87b6-62882b3f7796",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc21dbd5-9ea0-49d1-bf92-2d64ec2bad21",
"db_currency_id": "3b7f04f2-7176-45d7-a30f-938ee29a6536",
"db_language_id": "4d684f17-04ee-417b-8360-f187109a8e93",
"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-28T15:53:58.9907738+00:00"
},
"modified_dateutc": "2025-11-28T15:53:58.9907738+00:00"
},
"equipment_model_id": "5f9a0010-d870-4271-a236-c080792a9aa1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "db6a03cb-5bc9-4968-8917-9b3de3743120",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ab2397b3-4358-4504-b1f3-8814f509ae99",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4ea88042-6032-464d-8cb7-d440a8ca47c6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0ddf506f-a665-48cf-bf71-f5a97d1c11d5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b5c626c3-f79d-46a5-87b6-62882b3f7796",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc21dbd5-9ea0-49d1-bf92-2d64ec2bad21",
"db_currency_id": "3b7f04f2-7176-45d7-a30f-938ee29a6536",
"db_language_id": "4d684f17-04ee-417b-8360-f187109a8e93",
"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-28T15:53:58.9907738+00:00"
},
"modified_dateutc": "2025-11-28T15:53:58.9907738+00:00"
},
"equipment_family_id": "97942b6c-a472-425c-b15a-ef5e0046bb3a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e033b02c-8eb5-4832-a552-aafb83dd188d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ae2470d3-7a83-4b8f-89d9-d4882dce0460",
"_parent_code": "sample string 6",
"sales_organization_id": "5db30017-9054-4259-a2e7-436445730785",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b5c626c3-f79d-46a5-87b6-62882b3f7796",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc21dbd5-9ea0-49d1-bf92-2d64ec2bad21",
"db_currency_id": "3b7f04f2-7176-45d7-a30f-938ee29a6536",
"db_language_id": "4d684f17-04ee-417b-8360-f187109a8e93",
"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-28T15:53:58.9907738+00:00"
},
"modified_dateutc": "2025-11-28T15:53:58.9907738+00:00"
},
"date_in_production_since": "2025-11-28T15:53:58.9907738+00:00",
"date_out_of_production_since": "2025-11-28T15:53:58.9907738+00:00",
"date_end_support": "2025-11-28T15:53:58.9907738+00:00",
"sales_organization_id": "7ad78416-a43e-4c9f-ac90-7ba25f83d682",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b5c626c3-f79d-46a5-87b6-62882b3f7796",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc21dbd5-9ea0-49d1-bf92-2d64ec2bad21",
"db_currency_id": "3b7f04f2-7176-45d7-a30f-938ee29a6536",
"db_language_id": "4d684f17-04ee-417b-8360-f187109a8e93",
"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-28T15:53:58.9907738+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-28T15:53:58.9907738+00:00"
},
"project_status_id": "250c1b98-e06a-4e74-b484-68ef86370179",
"project_status_code": "sample string 10",
"project_status": {
"id": "34b85588-c7fc-4278-a917-6204947b84e6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b5761721-b73f-409d-9665-d2acc97b1cd5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b5c626c3-f79d-46a5-87b6-62882b3f7796",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc21dbd5-9ea0-49d1-bf92-2d64ec2bad21",
"db_currency_id": "3b7f04f2-7176-45d7-a30f-938ee29a6536",
"db_language_id": "4d684f17-04ee-417b-8360-f187109a8e93",
"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-28T15:53:58.9907738+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-28T15:53:58.9907738+00:00"
},
"company_id": "b312dc24-4947-49fc-bc3d-87327d637a42",
"company_code": "sample string 12",
"db_address_id": "fd9a6fbe-b4ee-48db-9312-974d41e76d23",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "92f15f74-a584-4315-907f-33acd03132c3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3a874a0f-a32e-4286-8371-17e2a7c49888",
"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-28T15:53:58.9907738+00:00",
"date_create": "2025-11-28T15:53:58.9907738+00:00",
"date_update": "2025-11-28T15:53:58.9907738+00:00",
"updated_by_user_id": "15d446ee-6dea-4a81-bb9b-598a23e7eef1",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-28T15:53:58.9907738+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-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-28T15:53:58.9907738+00:00",
"date_last_job": "2025-11-28T15:53:58.9907738+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-28T15:53:58.9907738+00:00",
"modified_dateutc": "2025-11-28T15:53:58.9907738+00:00",
"is_mobile_installation": true
},
"job_type_id": "fa6c22de-badf-4455-9d60-ef4c920dcf53",
"job_type_code": "sample string 7",
"job_type": {
"id": "824b1662-5f04-4c16-9e33-851ccece7a53",
"name": "sample string 2",
"sales_organization_id": "9c2240d5-78c0-41cc-96bc-6cbacb0993c1",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-28T15:53:58.9907738+00:00",
"code": "sample string 7"
},
"job_priority_id": "5ace5151-d3d9-4c63-8048-9f3d5a1abd12",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "80d4f1dc-9ffd-4af3-b4a8-1959f9d105ec",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1d197029-caaa-43da-98b9-4af973a6ebf2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b5c626c3-f79d-46a5-87b6-62882b3f7796",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc21dbd5-9ea0-49d1-bf92-2d64ec2bad21",
"db_currency_id": "3b7f04f2-7176-45d7-a30f-938ee29a6536",
"db_language_id": "4d684f17-04ee-417b-8360-f187109a8e93",
"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-28T15:53:58.9907738+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-28T15:53:58.9907738+00:00"
},
"job_status_id": "bb53704b-4704-4383-9227-0a796be7f60b",
"job_status_code": "sample string 11",
"db_address_id": "46f9d7fa-ac99-4937-8839-8c038ca61c4b",
"contact_id": "4e961baf-585e-4342-84e5-e24e02302599",
"requested_by_company_id": "4c5ab480-58d8-4b1b-b9aa-0263430c944f",
"requested_by_contact_id": "345ea98d-8396-4521-98a0-f0f783159072",
"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-28T15:53:58.9907738+00:00",
"due_date": "2025-11-28T15:53:58.9907738+00:00",
"date_create": "2025-11-28T15:53:58.9907738+00:00",
"date_update": "2025-11-28T15:53:58.9907738+00:00",
"date_closed": "2025-11-28T15:53:58.9907738+00:00",
"suggested_user_id": "c82d2ac7-c17f-43a0-9258-b161393c96af",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a81a9e96-4963-4163-af16-517f790f4c08",
"db_language_id": "9a887243-bf03-4ba7-a259-195a068d8abc",
"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-28T15:53:58.9907738+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8d8caccb-ebc6-4987-aaee-f3b362370bdd",
"sales_organization": {
"id": "b5c626c3-f79d-46a5-87b6-62882b3f7796",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc21dbd5-9ea0-49d1-bf92-2d64ec2bad21",
"db_currency_id": "3b7f04f2-7176-45d7-a30f-938ee29a6536",
"db_language_id": "4d684f17-04ee-417b-8360-f187109a8e93",
"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-28T15:53:58.9907738+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a331431c-9a39-43da-814d-76bac4aa50c3",
"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": "60d677d7-8daf-47b8-ae79-1427bf63db3f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-28T15:53:58.9907738+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a8399b1d-cfc9-4958-8da4-023efb8ebaf3"
},
"suggested_date_start": "2025-11-28T15:53:58.9907738+00:00",
"skill_id": "ba54fe95-204e-482b-af01-535590504d10",
"skill_code": "sample string 32",
"skill": {
"id": "9d3212dd-73ec-409f-b5b8-72e7a5a15cf2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "43b0fb5b-7a05-498c-8f28-78d171cf7357",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b5c626c3-f79d-46a5-87b6-62882b3f7796",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc21dbd5-9ea0-49d1-bf92-2d64ec2bad21",
"db_currency_id": "3b7f04f2-7176-45d7-a30f-938ee29a6536",
"db_language_id": "4d684f17-04ee-417b-8360-f187109a8e93",
"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-28T15:53:58.9907738+00:00"
},
"modified_dateutc": "2025-11-28T15:53:58.9907738+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "87217f57-b36a-4d2f-9386-69ae0867d4c4",
"date_reported_by_company": "2025-11-28T15:53:58.9907738+00:00",
"id2": 36,
"company_id": "a23c03fa-fa29-458f-92e1-09b2e907c087",
"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": "a9823880-d686-4344-a9ee-bc5eb49a9f81",
"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-28T15:53:58.9907738+00:00"
},
"work_instruction_details_id": "82c60f74-825e-4240-927c-261b1880d567",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "608bf45c-1d20-42c5-8844-39ec5c8de5cd",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d45722f1-1a12-44e1-88e7-bccb1e59ca7e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-28T15:53:58.9907738+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": "18c028e0-1e30-432b-a358-ecf8d32be121",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-28T15:53:58.9907738+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.