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": "542eecb2-7919-4b2c-b0ea-602d183f6029",
"jobs_id": "1d55c716-4b25-4511-a11f-4d76b4bcfdcc",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "89c43fa2-9c47-4545-83ac-3b50842e6f95",
"_parent_id": "c5ad6446-c6ff-4ccc-b1b5-f5b2dce73c8f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "62ab1e9d-8081-4afb-a2e9-07e3321d5791",
"project_reference_back_office": "sample string 5",
"project": {
"id": "71fb147e-072d-4379-ab0e-a6a64318f79d",
"_parent_id": "cce98737-d74e-415c-9140-8bf4309e3733",
"root_parent_id": "4a997701-cb58-446b-8dd3-ceeaa3f1b63c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "131d8ccd-6775-4c85-86aa-b9d53b954132",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "71660ebf-511d-4095-b05e-33d237f17ac9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9af8d5df-0f47-4cdf-87a6-ce739c7d6970",
"_parent_code": "sample string 6",
"sales_organization_id": "9295bea5-7023-4ff4-a8d8-4ff18e67b54f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ebc93b3b-45ae-4c72-99a6-deadceb165fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87b834d7-7fd0-4c7b-9316-bfa47fe0952a",
"db_currency_id": "a76705be-6806-4b2c-a8c6-534faeaa6c54",
"db_language_id": "c08b0c87-8131-4b8b-8545-d6823fa7e177",
"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-08-09T20:29:48.8702567+00:00"
},
"modified_dateutc": "2026-08-09T20:29:48.8702567+00:00"
},
"equipment_model_id": "0ddacf26-dc0f-48e3-92aa-6e1a4ea6fcae",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a21c7597-7a28-45e1-bac0-a3f1189f7f04",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "289ae919-1770-40f9-bafa-2318e45ee72f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "de2cee61-0e46-4e47-b140-326493dfa353",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ae585367-e2db-4f4e-8999-37be97bca843",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ebc93b3b-45ae-4c72-99a6-deadceb165fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87b834d7-7fd0-4c7b-9316-bfa47fe0952a",
"db_currency_id": "a76705be-6806-4b2c-a8c6-534faeaa6c54",
"db_language_id": "c08b0c87-8131-4b8b-8545-d6823fa7e177",
"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-08-09T20:29:48.8702567+00:00"
},
"modified_dateutc": "2026-08-09T20:29:48.8702567+00:00"
},
"equipment_family_id": "8b9631e2-9757-45cb-b445-3779073d6821",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "71660ebf-511d-4095-b05e-33d237f17ac9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9af8d5df-0f47-4cdf-87a6-ce739c7d6970",
"_parent_code": "sample string 6",
"sales_organization_id": "9295bea5-7023-4ff4-a8d8-4ff18e67b54f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ebc93b3b-45ae-4c72-99a6-deadceb165fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87b834d7-7fd0-4c7b-9316-bfa47fe0952a",
"db_currency_id": "a76705be-6806-4b2c-a8c6-534faeaa6c54",
"db_language_id": "c08b0c87-8131-4b8b-8545-d6823fa7e177",
"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-08-09T20:29:48.8702567+00:00"
},
"modified_dateutc": "2026-08-09T20:29:48.8702567+00:00"
},
"date_in_production_since": "2026-08-09T20:29:48.8702567+00:00",
"date_out_of_production_since": "2026-08-09T20:29:48.8702567+00:00",
"date_end_support": "2026-08-09T20:29:48.8702567+00:00",
"sales_organization_id": "c27f88de-197a-4561-9481-d6eb8cf8306f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ebc93b3b-45ae-4c72-99a6-deadceb165fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87b834d7-7fd0-4c7b-9316-bfa47fe0952a",
"db_currency_id": "a76705be-6806-4b2c-a8c6-534faeaa6c54",
"db_language_id": "c08b0c87-8131-4b8b-8545-d6823fa7e177",
"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-08-09T20:29:48.8702567+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-08-09T20:29:48.8702567+00:00"
},
"project_status_id": "a223328e-8e8e-4285-aa5e-ae77ccd64ddd",
"project_status_code": "sample string 10",
"project_status": {
"id": "e8b9eff2-ac44-4bdf-96a0-6635aed0e0b4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fb53fb87-f33d-422e-9c75-590360ab7312",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ebc93b3b-45ae-4c72-99a6-deadceb165fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87b834d7-7fd0-4c7b-9316-bfa47fe0952a",
"db_currency_id": "a76705be-6806-4b2c-a8c6-534faeaa6c54",
"db_language_id": "c08b0c87-8131-4b8b-8545-d6823fa7e177",
"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-08-09T20:29:48.8702567+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-09T20:29:48.8702567+00:00"
},
"company_id": "854b9822-4c13-46c5-9013-cf0a3960a0df",
"company_code": "sample string 12",
"db_address_id": "c6887ac3-c140-4c3e-be77-ad1b55b88296",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "085359ca-d755-4b07-a5c7-5bf5da74b3f7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c6c84ef7-8e10-49a3-a9e7-ba6dc2d94f17",
"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-08-09T20:29:48.8702567+00:00",
"date_create": "2026-08-09T20:29:48.8702567+00:00",
"date_update": "2026-08-09T20:29:48.8702567+00:00",
"updated_by_user_id": "0eee6683-e9ff-475b-9819-0e3967ce5209",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-09T20:29:48.8702567+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-08-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-09T20:29:48.8702567+00:00",
"date_last_job": "2026-08-09T20:29:48.8702567+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-09T20:29:48.8702567+00:00",
"modified_dateutc": "2026-08-09T20:29:48.8702567+00:00",
"is_mobile_installation": true
},
"job_type_id": "f9068caa-489d-4469-bb2e-dd310fc7313d",
"job_type_code": "sample string 7",
"job_type": {
"id": "fab264d3-5c51-42da-b6af-999042f5d84b",
"name": "sample string 2",
"sales_organization_id": "35fe5c26-b39e-427a-ac3a-9f5069b4e7ad",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-09T20:29:48.8702567+00:00",
"code": "sample string 7"
},
"job_priority_id": "e7cd9786-d1cf-447a-84a8-3b75a041521f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "203dc2b3-6bf8-48dd-93f5-c76e7f7ddc34",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b6426788-525e-46b3-8f50-efb2a04e676d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ebc93b3b-45ae-4c72-99a6-deadceb165fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87b834d7-7fd0-4c7b-9316-bfa47fe0952a",
"db_currency_id": "a76705be-6806-4b2c-a8c6-534faeaa6c54",
"db_language_id": "c08b0c87-8131-4b8b-8545-d6823fa7e177",
"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-08-09T20:29:48.8702567+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-09T20:29:48.8702567+00:00"
},
"job_status_id": "ba5242ac-0110-48fb-8393-71fb4ac490b7",
"job_status_code": "sample string 11",
"db_address_id": "a8795451-86c4-4176-9757-12b29f9db80a",
"contact_id": "2d4ad69f-5727-40be-aba8-296e4df5be9f",
"requested_by_company_id": "fea0e763-ca25-4d3c-9ff8-9b3b096526d5",
"requested_by_contact_id": "af7c52eb-f8e8-4139-a706-ad58e55a592e",
"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-08-09T20:29:48.8702567+00:00",
"due_date": "2026-08-09T20:29:48.8702567+00:00",
"date_create": "2026-08-09T20:29:48.8702567+00:00",
"date_update": "2026-08-09T20:29:48.8702567+00:00",
"date_closed": "2026-08-09T20:29:48.8702567+00:00",
"suggested_user_id": "0a77cb5e-d715-46eb-86e5-d2683e89706e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "04664dea-70f7-4114-b7e8-c2139a07a8bc",
"db_language_id": "19d0367e-0619-43a5-bab8-7db4099dc782",
"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-08-09T20:29:48.8702567+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "29d1be9a-9e0e-4ed8-b87e-50292d973d4f",
"sales_organization": {
"id": "ebc93b3b-45ae-4c72-99a6-deadceb165fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87b834d7-7fd0-4c7b-9316-bfa47fe0952a",
"db_currency_id": "a76705be-6806-4b2c-a8c6-534faeaa6c54",
"db_language_id": "c08b0c87-8131-4b8b-8545-d6823fa7e177",
"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-08-09T20:29:48.8702567+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7d363132-1057-43ee-b05c-c07a1abced19",
"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": "cde895de-bd13-49c3-b7dd-0b0fb6320da5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-09T20:29:48.8702567+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ecde8c7f-783b-4139-8492-59b1dc881345"
},
"suggested_date_start": "2026-08-09T20:29:48.8702567+00:00",
"skill_id": "bebc8e71-b776-4bec-bb26-eb5a5ca4c3b3",
"skill_code": "sample string 32",
"skill": {
"id": "c022832b-7085-48e9-8b5f-87e8c194c194",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3180b06d-94c0-44ab-b577-3900d844f4df",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ebc93b3b-45ae-4c72-99a6-deadceb165fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87b834d7-7fd0-4c7b-9316-bfa47fe0952a",
"db_currency_id": "a76705be-6806-4b2c-a8c6-534faeaa6c54",
"db_language_id": "c08b0c87-8131-4b8b-8545-d6823fa7e177",
"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-08-09T20:29:48.8702567+00:00"
},
"modified_dateutc": "2026-08-09T20:29:48.8702567+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "da2367a4-4821-4012-8959-a89b518c9859",
"date_reported_by_company": "2026-08-09T20:29:48.8702567+00:00",
"id2": 36,
"company_id": "862eb693-cea4-4815-914a-df3c3fb3a4e2",
"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": "b18f9176-52ff-453b-8fa8-fa409d9dc025",
"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-08-09T20:29:48.8702567+00:00"
},
"work_instruction_details_id": "c42bd508-3892-470f-b437-02cd4e9d0559",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "004f7eb5-ec3f-41b0-bc5c-2dfa5f25e25a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c73f6737-4bc3-47e8-9702-bbaf8635ad8a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-09T20:29:48.8702567+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": "2c65f006-f3ad-4225-9a27-c6da8de42d8a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-09T20:29:48.8702567+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.