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": "debda0a3-a068-4544-9cc0-967df188bde9",
"jobs_id": "fcbc36ac-5a2f-4da9-981f-0885577781f9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "20b3fb32-cff2-4fcd-8e77-9589605e79f5",
"_parent_id": "4fab4801-a16a-4497-abff-20b26e23f307",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d4a9775a-22dc-4237-8409-50075d560cb8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "991ee86f-9d72-49c0-9639-d3c95fee88f1",
"_parent_id": "b3dfd72c-bdd9-47a6-9ede-eda0766879a9",
"root_parent_id": "1051ad5e-a1d8-4089-9506-ee60dc788990",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "00aaaa2b-7f41-4c10-980d-36cc9cb52c61",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "631e01d6-4a02-43bc-9fc7-9a09db02510f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d20d8498-1fd6-4c8d-9872-2adfc5625904",
"_parent_code": "sample string 6",
"sales_organization_id": "afa38637-21cf-43bb-bfe7-17a993c3de67",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ed62087f-f3f1-45b7-a53f-3ff17ad5fc1f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8033c8d3-102d-4fb7-9923-dbc85bf2e21c",
"db_currency_id": "4f32f9af-cbcb-4559-b043-d5a087c2bd96",
"db_language_id": "07715f5e-f08e-4544-96e2-eb0b50f77eac",
"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-07-10T03:43:57.0053371+00:00"
},
"modified_dateutc": "2026-07-10T03:43:57.0053371+00:00"
},
"equipment_model_id": "4bfe7562-88ea-4928-956d-109e8f86e168",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "398ed25e-8479-4d7a-98a5-46d90bc79e1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b857145a-d960-4561-85df-c77a065b6970",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "453181b6-d3ca-494d-8fce-d80e4456da0a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5dd7a72c-7bc4-4a62-b141-68211e4c8ec7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ed62087f-f3f1-45b7-a53f-3ff17ad5fc1f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8033c8d3-102d-4fb7-9923-dbc85bf2e21c",
"db_currency_id": "4f32f9af-cbcb-4559-b043-d5a087c2bd96",
"db_language_id": "07715f5e-f08e-4544-96e2-eb0b50f77eac",
"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-07-10T03:43:57.0053371+00:00"
},
"modified_dateutc": "2026-07-10T03:43:57.0053371+00:00"
},
"equipment_family_id": "e7f76bea-f3ed-4ef1-8919-304d32dced7a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "631e01d6-4a02-43bc-9fc7-9a09db02510f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d20d8498-1fd6-4c8d-9872-2adfc5625904",
"_parent_code": "sample string 6",
"sales_organization_id": "afa38637-21cf-43bb-bfe7-17a993c3de67",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ed62087f-f3f1-45b7-a53f-3ff17ad5fc1f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8033c8d3-102d-4fb7-9923-dbc85bf2e21c",
"db_currency_id": "4f32f9af-cbcb-4559-b043-d5a087c2bd96",
"db_language_id": "07715f5e-f08e-4544-96e2-eb0b50f77eac",
"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-07-10T03:43:57.0053371+00:00"
},
"modified_dateutc": "2026-07-10T03:43:57.0053371+00:00"
},
"date_in_production_since": "2026-07-10T03:43:57.0053371+00:00",
"date_out_of_production_since": "2026-07-10T03:43:57.0053371+00:00",
"date_end_support": "2026-07-10T03:43:57.0053371+00:00",
"sales_organization_id": "52ff1cd4-e632-4263-9ab6-5e84cb813989",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ed62087f-f3f1-45b7-a53f-3ff17ad5fc1f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8033c8d3-102d-4fb7-9923-dbc85bf2e21c",
"db_currency_id": "4f32f9af-cbcb-4559-b043-d5a087c2bd96",
"db_language_id": "07715f5e-f08e-4544-96e2-eb0b50f77eac",
"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-07-10T03:43:57.0053371+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-07-10T03:43:57.0053371+00:00"
},
"project_status_id": "daadc3c6-733c-4030-a192-13314630431d",
"project_status_code": "sample string 10",
"project_status": {
"id": "1538fe41-29af-4938-9ff8-ee14d1bbea36",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "01817941-7c89-4763-9a90-619663962cfa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ed62087f-f3f1-45b7-a53f-3ff17ad5fc1f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8033c8d3-102d-4fb7-9923-dbc85bf2e21c",
"db_currency_id": "4f32f9af-cbcb-4559-b043-d5a087c2bd96",
"db_language_id": "07715f5e-f08e-4544-96e2-eb0b50f77eac",
"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-07-10T03:43:57.0053371+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-10T03:43:57.0053371+00:00"
},
"company_id": "691b68ac-10cd-40a7-bf44-54e8787f5f1e",
"company_code": "sample string 12",
"db_address_id": "461b7282-2d8e-49e1-a60f-8dd44fd380a4",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "742c9549-38c8-412d-9346-18c30297f85b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d67e6817-f2b0-48f7-97c5-1865a6c1f156",
"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-07-10T03:43:57.0053371+00:00",
"date_create": "2026-07-10T03:43:57.0053371+00:00",
"date_update": "2026-07-10T03:43:57.0053371+00:00",
"updated_by_user_id": "d5a55f13-61b6-4525-99db-1dab0d2d7a13",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-10T03:43:57.0053371+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-07-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-10T03:43:57.0053371+00:00",
"date_last_job": "2026-07-10T03:43:57.0053371+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-10T03:43:57.0053371+00:00",
"modified_dateutc": "2026-07-10T03:43:57.0053371+00:00",
"is_mobile_installation": true
},
"job_type_id": "15669ef2-4610-441c-a238-4df5bef68b1d",
"job_type_code": "sample string 7",
"job_type": {
"id": "d589ed36-1885-4a70-ba21-dfe548cc303d",
"name": "sample string 2",
"sales_organization_id": "8f5fac08-f611-4b63-9975-6070a48534a3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-10T03:43:57.0053371+00:00",
"code": "sample string 7"
},
"job_priority_id": "daa21fba-251d-4156-9c16-f72830cdd6b6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "08e9a50f-b1c2-49b6-8d65-bcdca8d3a381",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e7e530cc-2313-4dc4-8956-ae869f199b0e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ed62087f-f3f1-45b7-a53f-3ff17ad5fc1f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8033c8d3-102d-4fb7-9923-dbc85bf2e21c",
"db_currency_id": "4f32f9af-cbcb-4559-b043-d5a087c2bd96",
"db_language_id": "07715f5e-f08e-4544-96e2-eb0b50f77eac",
"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-07-10T03:43:57.0053371+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-10T03:43:57.0053371+00:00"
},
"job_status_id": "1f8ed676-5fa2-4588-a204-e6f1f89c7b3d",
"job_status_code": "sample string 11",
"db_address_id": "ab3a5118-cdb5-4ab4-b04d-62ce67d2c93f",
"contact_id": "e9184663-9127-4332-ab9f-e58f67d5e77f",
"requested_by_company_id": "410c7cfb-57e9-4a94-9d26-4fba4b26e0db",
"requested_by_contact_id": "f1a9e5e6-ca17-4d52-b78c-38201d868bac",
"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-07-10T03:43:57.0053371+00:00",
"due_date": "2026-07-10T03:43:57.0053371+00:00",
"date_create": "2026-07-10T03:43:57.0053371+00:00",
"date_update": "2026-07-10T03:43:57.0053371+00:00",
"date_closed": "2026-07-10T03:43:57.0053371+00:00",
"suggested_user_id": "cde900aa-edc5-4b6a-b97f-8873c03f18df",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2aa13b92-0897-495d-951a-4ca40e02b046",
"db_language_id": "234f9c21-0a6c-4a72-bfe6-dd70b96e3aea",
"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-07-10T03:43:57.0053371+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4dbc2468-0dc5-4207-b695-5381e2bcb4e6",
"sales_organization": {
"id": "ed62087f-f3f1-45b7-a53f-3ff17ad5fc1f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8033c8d3-102d-4fb7-9923-dbc85bf2e21c",
"db_currency_id": "4f32f9af-cbcb-4559-b043-d5a087c2bd96",
"db_language_id": "07715f5e-f08e-4544-96e2-eb0b50f77eac",
"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-07-10T03:43:57.0053371+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a6c63b93-6ed0-4061-8a44-7a375c4028d9",
"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": "b410e1f4-3bf1-46bb-83c9-a5f07c27c6c9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-10T03:43:57.0053371+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0fc43098-b1d2-4f70-ac44-d97a9878b619"
},
"suggested_date_start": "2026-07-10T03:43:57.0053371+00:00",
"skill_id": "29dde123-2247-4d3c-bdf2-5e3331f4acf5",
"skill_code": "sample string 32",
"skill": {
"id": "d5a0eabc-8f61-418d-8ce2-73f15a5e2bf4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2ae47707-517b-4c94-99f0-13a3c59d439e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ed62087f-f3f1-45b7-a53f-3ff17ad5fc1f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8033c8d3-102d-4fb7-9923-dbc85bf2e21c",
"db_currency_id": "4f32f9af-cbcb-4559-b043-d5a087c2bd96",
"db_language_id": "07715f5e-f08e-4544-96e2-eb0b50f77eac",
"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-07-10T03:43:57.0053371+00:00"
},
"modified_dateutc": "2026-07-10T03:43:57.0053371+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c36397cf-fbf1-4105-838d-c640bc19c386",
"date_reported_by_company": "2026-07-10T03:43:57.0053371+00:00",
"id2": 36,
"company_id": "091e01c9-5c1b-408f-8cba-c010fe21f0da",
"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": "3137b7ce-2fc7-4aad-9219-07403bd1baa6",
"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-07-10T03:43:57.0053371+00:00"
},
"work_instruction_details_id": "0ad96b95-4933-4f1f-aca6-abb4ead1a3e5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1f9b5e47-f6ae-4c7c-91aa-e1c8ea7b0dce",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "905f7e24-8abb-4a95-b625-114533df33f2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-10T03:43:57.0053371+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": "c53fbcca-f5ff-436d-8093-74f12cea77ff",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-10T03:43:57.0053371+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.