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": "f9f1736b-0302-4cdd-b237-38cf981c4774",
"jobs_id": "756e0603-7c82-4b14-b015-daa7f88704e2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "04bab17d-9325-4263-80ec-b8d271969ac8",
"_parent_id": "5e2f911c-b96d-409e-a875-bda00afb45f6",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "534a775a-4fa1-4147-8611-bf94b7b35ef2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "fbd6dc7e-9d49-4d66-8bd1-bdc94917de53",
"_parent_id": "710d62be-4495-4650-8fc8-16b61cc84ae2",
"root_parent_id": "0b10c366-6d9c-49ed-b485-62a2ed83d7df",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c717a85b-e1e6-45d3-9e70-5a7c1c76dd12",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "383bb4d9-a6fe-4271-a029-160727109e95",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "024d257c-ee94-4f11-a027-c39b7178b904",
"_parent_code": "sample string 6",
"sales_organization_id": "bab3f725-b8e5-41e0-b82f-62c8d31b147c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "51f93977-9893-497a-8385-a25e4ba392c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2b06f4d2-98e3-4df1-88b6-d0538ae9e70a",
"db_currency_id": "aeaa12ca-42a5-4c8c-859a-789a152b4d10",
"db_language_id": "1fe60668-91c1-4790-a6e0-81c6c86fd709",
"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-15T23:21:43.6783889+00:00"
},
"modified_dateutc": "2026-09-15T23:21:43.6783889+00:00"
},
"equipment_model_id": "20a8f316-a799-429a-98dd-cc20d8d568f1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6f9f718e-9f77-47f4-92ed-5f697fbe77b4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "968512c6-0bb6-4120-9cb5-f7e02b1f1e45",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1f7e2e4b-d151-4cbd-9873-5e1dae438019",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b2113314-eebe-4053-8b22-89263660402e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "51f93977-9893-497a-8385-a25e4ba392c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2b06f4d2-98e3-4df1-88b6-d0538ae9e70a",
"db_currency_id": "aeaa12ca-42a5-4c8c-859a-789a152b4d10",
"db_language_id": "1fe60668-91c1-4790-a6e0-81c6c86fd709",
"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-15T23:21:43.6783889+00:00"
},
"modified_dateutc": "2026-09-15T23:21:43.6783889+00:00"
},
"equipment_family_id": "3bd90c0d-9cca-4744-8083-13a924701e5f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "383bb4d9-a6fe-4271-a029-160727109e95",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "024d257c-ee94-4f11-a027-c39b7178b904",
"_parent_code": "sample string 6",
"sales_organization_id": "bab3f725-b8e5-41e0-b82f-62c8d31b147c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "51f93977-9893-497a-8385-a25e4ba392c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2b06f4d2-98e3-4df1-88b6-d0538ae9e70a",
"db_currency_id": "aeaa12ca-42a5-4c8c-859a-789a152b4d10",
"db_language_id": "1fe60668-91c1-4790-a6e0-81c6c86fd709",
"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-15T23:21:43.6783889+00:00"
},
"modified_dateutc": "2026-09-15T23:21:43.6783889+00:00"
},
"date_in_production_since": "2026-09-15T23:21:43.6783889+00:00",
"date_out_of_production_since": "2026-09-15T23:21:43.6783889+00:00",
"date_end_support": "2026-09-15T23:21:43.6783889+00:00",
"sales_organization_id": "fe0dd6ca-d632-4fba-ad5b-813bad840694",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "51f93977-9893-497a-8385-a25e4ba392c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2b06f4d2-98e3-4df1-88b6-d0538ae9e70a",
"db_currency_id": "aeaa12ca-42a5-4c8c-859a-789a152b4d10",
"db_language_id": "1fe60668-91c1-4790-a6e0-81c6c86fd709",
"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-15T23:21:43.6783889+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-15T23:21:43.6783889+00:00"
},
"project_status_id": "ac46405c-0091-4afa-9292-50009f35bc1f",
"project_status_code": "sample string 10",
"project_status": {
"id": "a6b2ccf9-e2df-49a3-8067-023196a34722",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d5555b39-31fb-4547-80bb-d4782cf9edf5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "51f93977-9893-497a-8385-a25e4ba392c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2b06f4d2-98e3-4df1-88b6-d0538ae9e70a",
"db_currency_id": "aeaa12ca-42a5-4c8c-859a-789a152b4d10",
"db_language_id": "1fe60668-91c1-4790-a6e0-81c6c86fd709",
"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-15T23:21:43.6783889+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-15T23:21:43.6783889+00:00"
},
"company_id": "6ab28fe7-a2d4-4de0-870a-068849c85a03",
"company_code": "sample string 12",
"db_address_id": "36cc2c0b-733b-4e4a-8516-cd556b3edbea",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1551e339-dbf1-4019-b4a3-c8e0918f38a3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "67b0d46e-9276-4be5-b72a-2c148672605f",
"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-15T23:21:43.6783889+00:00",
"date_create": "2026-09-15T23:21:43.6783889+00:00",
"date_update": "2026-09-15T23:21:43.6783889+00:00",
"updated_by_user_id": "08e2c880-c320-44fb-be5c-22a806d0a3e2",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-15T23:21:43.6783889+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-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-15T23:21:43.6783889+00:00",
"date_last_job": "2026-09-15T23:21:43.6783889+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-15T23:21:43.6783889+00:00",
"modified_dateutc": "2026-09-15T23:21:43.6783889+00:00",
"is_mobile_installation": true
},
"job_type_id": "59f0dd54-080f-4a24-b0c1-63cb804d3aca",
"job_type_code": "sample string 7",
"job_type": {
"id": "8bb69f8e-7d32-4c90-80d0-b729429cd572",
"name": "sample string 2",
"sales_organization_id": "6545545c-1ca1-4c7f-9094-fc8f7a89ebf5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-15T23:21:43.6783889+00:00",
"code": "sample string 7"
},
"job_priority_id": "d53e75e1-8091-460f-8606-1add3032b87a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5d73455e-689a-4a1c-95d8-7b49dea22d2c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9b193ff3-c76e-4b7d-ace8-86002f7ab4ab",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "51f93977-9893-497a-8385-a25e4ba392c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2b06f4d2-98e3-4df1-88b6-d0538ae9e70a",
"db_currency_id": "aeaa12ca-42a5-4c8c-859a-789a152b4d10",
"db_language_id": "1fe60668-91c1-4790-a6e0-81c6c86fd709",
"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-15T23:21:43.6783889+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-15T23:21:43.6783889+00:00"
},
"job_status_id": "9df36b3d-9398-441c-bcd1-1a8541756721",
"job_status_code": "sample string 11",
"db_address_id": "310881fd-101d-428f-a626-59f4c9ef0c7c",
"contact_id": "782a2d7e-9d89-4de6-9e49-342576d4eb28",
"requested_by_company_id": "b08f0e0d-5474-45bd-ad83-c0e024b6d73d",
"requested_by_contact_id": "f6ff607b-53d9-4d28-acd1-65279da25108",
"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-15T23:21:43.6783889+00:00",
"due_date": "2026-09-15T23:21:43.6783889+00:00",
"date_create": "2026-09-15T23:21:43.6783889+00:00",
"date_update": "2026-09-15T23:21:43.6783889+00:00",
"date_closed": "2026-09-15T23:21:43.6783889+00:00",
"suggested_user_id": "3fb89f1e-4654-4504-8bb4-f7ee71051231",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6e7cdb6b-8eea-4f5b-95d3-5c7865aae385",
"db_language_id": "c2e3aa00-1a55-4cbe-942f-6fc1e8ff238b",
"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-15T23:21:43.6783889+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "17c363ff-45d7-4b31-bacb-e01ad4db4d3c",
"sales_organization": {
"id": "51f93977-9893-497a-8385-a25e4ba392c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2b06f4d2-98e3-4df1-88b6-d0538ae9e70a",
"db_currency_id": "aeaa12ca-42a5-4c8c-859a-789a152b4d10",
"db_language_id": "1fe60668-91c1-4790-a6e0-81c6c86fd709",
"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-15T23:21:43.6783889+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "438d708e-1630-48a7-903e-b64e0d119082",
"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": "9d7101ad-c1b5-46cb-acdd-0e5097b29d20",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-15T23:21:43.6783889+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "559dd10b-6dad-4533-893f-e6dfd63a08b0"
},
"suggested_date_start": "2026-09-15T23:21:43.6783889+00:00",
"skill_id": "72dfd9da-8ece-4108-9b40-b6993ec45e92",
"skill_code": "sample string 32",
"skill": {
"id": "49bc8249-9bcc-4a53-b8d5-0cb79c1640ed",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "eea82936-7500-4ef4-844f-559ef85c5767",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "51f93977-9893-497a-8385-a25e4ba392c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2b06f4d2-98e3-4df1-88b6-d0538ae9e70a",
"db_currency_id": "aeaa12ca-42a5-4c8c-859a-789a152b4d10",
"db_language_id": "1fe60668-91c1-4790-a6e0-81c6c86fd709",
"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-15T23:21:43.6783889+00:00"
},
"modified_dateutc": "2026-09-15T23:21:43.6783889+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "cbd95132-531b-46f9-af11-42946a948a2b",
"date_reported_by_company": "2026-09-15T23:21:43.6783889+00:00",
"id2": 36,
"company_id": "a18ed6b3-658f-40c2-8ea6-220b72eabef3",
"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": "84f7a630-8e65-4845-a1c9-aaed3e3a23fe",
"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-15T23:21:43.6783889+00:00"
},
"work_instruction_details_id": "fbbdb66b-9c1a-41d3-aba8-adcab56d3de1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7aa2cd61-8bdc-4778-83db-95080560c1f9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8623018a-a1ac-4986-9731-dedc9bb5d3c9",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-15T23:21:43.6783889+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": "3e72f7fa-664c-4def-8202-c7acb032f6c1",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-15T23:21:43.6783889+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.