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": "435211b6-375b-4b2c-8f5a-2017bddc8abe",
"jobs_id": "7b5f0cf5-f743-4400-8715-4a6afc891d1c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e2c0b436-acec-44ca-acfc-d8741ae9ac1f",
"_parent_id": "5c981894-cea4-4815-aa98-5be13ac5ec37",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "43175460-ccc2-49e3-8330-ed6e205895fe",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e4fb542c-e3f9-45ed-a273-340cf8ba2e69",
"_parent_id": "a316e88b-df78-4613-a7da-5b9e9db8c361",
"root_parent_id": "b4ce54e7-3d63-48c2-9113-daaf430f39a0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "10b99e50-a445-4339-9385-f107179701f6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "975c2d2e-fd21-4b4f-af52-25389a6f7d82",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "99732ab2-3c68-48ce-ad6f-9f86143ea1a8",
"_parent_code": "sample string 6",
"sales_organization_id": "07e7a6c7-eaab-4aa4-a4a0-f3fe50d6fc1c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "49e09c89-dff9-4e40-a59b-ab399c0a38c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66f07de6-1648-4e85-ab64-0d36f69a5093",
"db_currency_id": "b00abe16-0a97-4282-86a1-e5f86811bd75",
"db_language_id": "eea65ca0-bf9a-44b3-b652-0b1014d826b0",
"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-01-28T15:07:02.8578062+00:00"
},
"modified_dateutc": "2026-01-28T15:07:02.8578062+00:00"
},
"equipment_model_id": "f83d8e82-8b99-4601-b45d-e962db98a768",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7cba52b6-c9b6-44f9-b4bb-96a965552e4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "634359d9-b60b-4efc-ac47-8d24dffa0302",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0779425b-ca9a-43ba-90f5-dd6d28df88f3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a3b4d373-1d8c-4270-9242-15af5ec0feb6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "49e09c89-dff9-4e40-a59b-ab399c0a38c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66f07de6-1648-4e85-ab64-0d36f69a5093",
"db_currency_id": "b00abe16-0a97-4282-86a1-e5f86811bd75",
"db_language_id": "eea65ca0-bf9a-44b3-b652-0b1014d826b0",
"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-01-28T15:07:02.8578062+00:00"
},
"modified_dateutc": "2026-01-28T15:07:02.8578062+00:00"
},
"equipment_family_id": "360f7728-39f4-4f48-9629-250637f2429a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "975c2d2e-fd21-4b4f-af52-25389a6f7d82",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "99732ab2-3c68-48ce-ad6f-9f86143ea1a8",
"_parent_code": "sample string 6",
"sales_organization_id": "07e7a6c7-eaab-4aa4-a4a0-f3fe50d6fc1c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "49e09c89-dff9-4e40-a59b-ab399c0a38c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66f07de6-1648-4e85-ab64-0d36f69a5093",
"db_currency_id": "b00abe16-0a97-4282-86a1-e5f86811bd75",
"db_language_id": "eea65ca0-bf9a-44b3-b652-0b1014d826b0",
"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-01-28T15:07:02.8578062+00:00"
},
"modified_dateutc": "2026-01-28T15:07:02.8578062+00:00"
},
"date_in_production_since": "2026-01-28T15:07:02.8578062+00:00",
"date_out_of_production_since": "2026-01-28T15:07:02.8578062+00:00",
"date_end_support": "2026-01-28T15:07:02.8578062+00:00",
"sales_organization_id": "675e0c3e-6427-44ba-8420-5a6b8ddf5d1e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "49e09c89-dff9-4e40-a59b-ab399c0a38c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66f07de6-1648-4e85-ab64-0d36f69a5093",
"db_currency_id": "b00abe16-0a97-4282-86a1-e5f86811bd75",
"db_language_id": "eea65ca0-bf9a-44b3-b652-0b1014d826b0",
"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-01-28T15:07:02.8578062+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-01-28T15:07:02.8578062+00:00"
},
"project_status_id": "cff5b5b3-295e-4405-91e9-28c9d72a257e",
"project_status_code": "sample string 10",
"project_status": {
"id": "32020114-1d94-4250-9f04-ee1e61e05e6a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7394f579-cb3f-4741-8836-55b0acf42038",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "49e09c89-dff9-4e40-a59b-ab399c0a38c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66f07de6-1648-4e85-ab64-0d36f69a5093",
"db_currency_id": "b00abe16-0a97-4282-86a1-e5f86811bd75",
"db_language_id": "eea65ca0-bf9a-44b3-b652-0b1014d826b0",
"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-01-28T15:07:02.8578062+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-28T15:07:02.8578062+00:00"
},
"company_id": "d39d0b99-28b0-4e4b-96d7-2fd70550e0c1",
"company_code": "sample string 12",
"db_address_id": "55322abe-39e0-4542-add9-82efd3ef7743",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3b6fe936-9a6a-4923-8089-6317ae74941f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e95ee81e-5291-4b02-ada2-38184bef4bf7",
"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-01-28T15:07:02.8578062+00:00",
"date_create": "2026-01-28T15:07:02.8578062+00:00",
"date_update": "2026-01-28T15:07:02.8578062+00:00",
"updated_by_user_id": "715200f8-c8e6-451d-b637-3b333b6c7427",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-28T15:07:02.8578062+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-01-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-28T15:07:02.8578062+00:00",
"date_last_job": "2026-01-28T15:07:02.8578062+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-28T15:07:02.8578062+00:00",
"modified_dateutc": "2026-01-28T15:07:02.8578062+00:00",
"is_mobile_installation": true
},
"job_type_id": "f34ae5f1-2d3d-4d3a-811c-37a599ec7ab5",
"job_type_code": "sample string 7",
"job_type": {
"id": "5684b536-12ae-44dd-be3d-89ba938cc137",
"name": "sample string 2",
"sales_organization_id": "5d52858e-cf90-445c-8391-59ec88490a5c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-28T15:07:02.8578062+00:00",
"code": "sample string 7"
},
"job_priority_id": "9b1e0f3a-9659-4869-b8d8-07274a0cc82b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "539a29e6-da06-4686-8332-e4b2dad03053",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6b8b455a-b05d-416a-a128-8288b4da6398",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "49e09c89-dff9-4e40-a59b-ab399c0a38c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66f07de6-1648-4e85-ab64-0d36f69a5093",
"db_currency_id": "b00abe16-0a97-4282-86a1-e5f86811bd75",
"db_language_id": "eea65ca0-bf9a-44b3-b652-0b1014d826b0",
"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-01-28T15:07:02.8578062+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-28T15:07:02.8578062+00:00"
},
"job_status_id": "a9df7b5b-7689-4855-919f-bf2c867104db",
"job_status_code": "sample string 11",
"db_address_id": "98a2df28-7ee8-46fa-9d44-68984f098c7f",
"contact_id": "32d7d16b-32b2-4d69-b6b8-b0957849a765",
"requested_by_company_id": "fc2111ee-a4db-4776-b792-7d9ff872bc13",
"requested_by_contact_id": "ffcb76d3-307b-4e5e-8f76-2b6b5244980b",
"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-01-28T15:07:02.8578062+00:00",
"due_date": "2026-01-28T15:07:02.8734311+00:00",
"date_create": "2026-01-28T15:07:02.8734311+00:00",
"date_update": "2026-01-28T15:07:02.8734311+00:00",
"date_closed": "2026-01-28T15:07:02.8734311+00:00",
"suggested_user_id": "c2caca29-5355-4f56-a702-b6b05d5a04c6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c699cad4-02ae-4507-bc37-bac6194e7212",
"db_language_id": "fe265dbb-b412-48f6-854e-e79f623b8a79",
"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-01-28T15:07:02.8734311+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "93a4e087-a583-4f9f-9d21-4954f5bdaf43",
"sales_organization": {
"id": "49e09c89-dff9-4e40-a59b-ab399c0a38c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66f07de6-1648-4e85-ab64-0d36f69a5093",
"db_currency_id": "b00abe16-0a97-4282-86a1-e5f86811bd75",
"db_language_id": "eea65ca0-bf9a-44b3-b652-0b1014d826b0",
"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-01-28T15:07:02.8578062+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0d81b5f0-e0f5-4aab-9b7e-29783683bd01",
"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": "db1360f5-beb8-4b1f-a921-97811b841b52",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-28T15:07:02.8734311+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e21f02d4-b2ad-492a-a308-20c9c30cd15e"
},
"suggested_date_start": "2026-01-28T15:07:02.8734311+00:00",
"skill_id": "a02310ae-5eaa-4ff7-aae3-420010cf9ac4",
"skill_code": "sample string 32",
"skill": {
"id": "571a3fe7-ab11-4e2f-bb2d-2ee0b1814699",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "51c1692b-e01d-4a2d-a251-d1e7cac3e45a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "49e09c89-dff9-4e40-a59b-ab399c0a38c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66f07de6-1648-4e85-ab64-0d36f69a5093",
"db_currency_id": "b00abe16-0a97-4282-86a1-e5f86811bd75",
"db_language_id": "eea65ca0-bf9a-44b3-b652-0b1014d826b0",
"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-01-28T15:07:02.8578062+00:00"
},
"modified_dateutc": "2026-01-28T15:07:02.8734311+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "71e84c81-81e5-4d41-af1b-24cb34dc8682",
"date_reported_by_company": "2026-01-28T15:07:02.8734311+00:00",
"id2": 36,
"company_id": "dc80d3bc-3519-4a0f-bc97-7d2709861028",
"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": "7f62653d-9a66-4516-b0cc-cd56a9753345",
"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-01-28T15:07:02.8734311+00:00"
},
"work_instruction_details_id": "036f1640-346a-4cee-91d7-6bc9d2f6b895",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4b7c821d-44c1-44db-98af-a3ca779007c3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cbb4a396-e0fd-4da1-8e08-ef54d347735a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-28T15:07:02.8734311+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": "ae89a05d-968b-43a2-bc42-518086d1fe40",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-28T15:07:02.8734311+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.