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": "75b77d1f-cf70-41e2-8528-71bb02edfe47",
"jobs_id": "a0483f3e-a79f-4252-a293-6a9056968465",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b2653bcb-39b1-4cba-be9e-0ebe11566d07",
"_parent_id": "65365734-f242-4f3e-83a7-7d5d6d5113ab",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "acc00ced-fe6d-4e97-a4f8-ff524e9e4725",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ed31d0fe-7d56-475d-923b-fda0acee32b2",
"_parent_id": "3d2f02c4-bd65-42e6-baf2-928db2e105b3",
"root_parent_id": "612a9e98-fd0d-45a4-8429-002dc6d6dc78",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a9447d29-c8a6-4197-aab5-224724a63bef",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a81a3a69-cd63-4c29-b42a-b7eac851d869",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1dcd52f1-55db-4390-aaf8-95464404c779",
"_parent_code": "sample string 6",
"sales_organization_id": "d9cb4802-0fe0-4f55-865d-297d13694e19",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5ca7f440-a30f-4017-8e9b-7e3b0eed1fe1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5fbf0b6a-eebd-4592-9d0e-db6fea0705d0",
"db_currency_id": "980cc745-c8f3-4efa-90a5-d79972319939",
"db_language_id": "b6612e48-e8d3-438c-918b-6145ae423b1c",
"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-28T01:13:28.639482+00:00"
},
"modified_dateutc": "2026-09-28T01:13:28.639482+00:00"
},
"equipment_model_id": "f2905c90-e47b-4a8a-a212-3a85e651d37e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0c6f710d-43d8-401d-a313-bb1ac32551c3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "266b0c04-561e-4a57-b3e9-20ba30071b24",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9ad1e7be-c74d-49cf-b8a2-ae1c824dbcec",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a2696853-2337-46f7-992d-bb05c83507b0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5ca7f440-a30f-4017-8e9b-7e3b0eed1fe1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5fbf0b6a-eebd-4592-9d0e-db6fea0705d0",
"db_currency_id": "980cc745-c8f3-4efa-90a5-d79972319939",
"db_language_id": "b6612e48-e8d3-438c-918b-6145ae423b1c",
"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-28T01:13:28.639482+00:00"
},
"modified_dateutc": "2026-09-28T01:13:28.639482+00:00"
},
"equipment_family_id": "2d9ac612-a89e-4035-a9bf-3e9627951428",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a81a3a69-cd63-4c29-b42a-b7eac851d869",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1dcd52f1-55db-4390-aaf8-95464404c779",
"_parent_code": "sample string 6",
"sales_organization_id": "d9cb4802-0fe0-4f55-865d-297d13694e19",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5ca7f440-a30f-4017-8e9b-7e3b0eed1fe1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5fbf0b6a-eebd-4592-9d0e-db6fea0705d0",
"db_currency_id": "980cc745-c8f3-4efa-90a5-d79972319939",
"db_language_id": "b6612e48-e8d3-438c-918b-6145ae423b1c",
"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-28T01:13:28.639482+00:00"
},
"modified_dateutc": "2026-09-28T01:13:28.639482+00:00"
},
"date_in_production_since": "2026-09-28T01:13:28.639482+00:00",
"date_out_of_production_since": "2026-09-28T01:13:28.639482+00:00",
"date_end_support": "2026-09-28T01:13:28.639482+00:00",
"sales_organization_id": "563ee7a3-cdb5-46cc-b943-cc102ffc569b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5ca7f440-a30f-4017-8e9b-7e3b0eed1fe1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5fbf0b6a-eebd-4592-9d0e-db6fea0705d0",
"db_currency_id": "980cc745-c8f3-4efa-90a5-d79972319939",
"db_language_id": "b6612e48-e8d3-438c-918b-6145ae423b1c",
"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-28T01:13:28.639482+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-28T01:13:28.639482+00:00"
},
"project_status_id": "89c7f102-cec9-4db3-baee-484e96d795c7",
"project_status_code": "sample string 10",
"project_status": {
"id": "ee8a5dfd-5c07-4e4d-8a14-86caae4fb457",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "bb403944-0441-43bd-b4c5-0b3693207e60",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5ca7f440-a30f-4017-8e9b-7e3b0eed1fe1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5fbf0b6a-eebd-4592-9d0e-db6fea0705d0",
"db_currency_id": "980cc745-c8f3-4efa-90a5-d79972319939",
"db_language_id": "b6612e48-e8d3-438c-918b-6145ae423b1c",
"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-28T01:13:28.639482+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-28T01:13:28.639482+00:00"
},
"company_id": "dee64436-5bed-4e75-b47b-4f8f17c7159b",
"company_code": "sample string 12",
"db_address_id": "4a567f95-d9a3-4d2d-80a4-839b580d1842",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d818830f-f475-4885-83ac-70e9ddb3d01c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "858a4b20-f1ca-4e7a-9b44-68f916f35628",
"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-28T01:13:28.639482+00:00",
"date_create": "2026-09-28T01:13:28.639482+00:00",
"date_update": "2026-09-28T01:13:28.639482+00:00",
"updated_by_user_id": "cb2ba068-f076-4b5f-b1a6-5d4edcfb31f7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-28T01:13:28.639482+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-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-28T01:13:28.639482+00:00",
"date_last_job": "2026-09-28T01:13:28.639482+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-28T01:13:28.639482+00:00",
"modified_dateutc": "2026-09-28T01:13:28.639482+00:00",
"is_mobile_installation": true
},
"job_type_id": "7a9baa6d-5194-4757-bf09-35a1794d3408",
"job_type_code": "sample string 7",
"job_type": {
"id": "54b09014-3d4b-4892-9a57-f9190e1bdd1f",
"name": "sample string 2",
"sales_organization_id": "8d18fd71-cd26-4c7e-b60a-917c23f25839",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-28T01:13:28.639482+00:00",
"code": "sample string 7"
},
"job_priority_id": "a32dfff6-7095-425a-a3ff-93f95ace9955",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ac74a1b9-d25d-4193-a6fe-e977da0822bf",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a0cbfd3a-86e1-4d75-a070-911838ea99f1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5ca7f440-a30f-4017-8e9b-7e3b0eed1fe1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5fbf0b6a-eebd-4592-9d0e-db6fea0705d0",
"db_currency_id": "980cc745-c8f3-4efa-90a5-d79972319939",
"db_language_id": "b6612e48-e8d3-438c-918b-6145ae423b1c",
"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-28T01:13:28.639482+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-28T01:13:28.639482+00:00"
},
"job_status_id": "e566d81f-c7c7-4f59-9e38-8f1d4b47b704",
"job_status_code": "sample string 11",
"db_address_id": "7797da4f-251a-413c-a2ad-7d2b1944ab38",
"contact_id": "3b8e37ed-14c3-4e72-8a8d-394b9f970de0",
"requested_by_company_id": "e5304f9f-eea4-4727-ab1e-ecafe01edf4c",
"requested_by_contact_id": "bab287df-5671-461d-abaa-307e1061be50",
"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-28T01:13:28.639482+00:00",
"due_date": "2026-09-28T01:13:28.639482+00:00",
"date_create": "2026-09-28T01:13:28.639482+00:00",
"date_update": "2026-09-28T01:13:28.639482+00:00",
"date_closed": "2026-09-28T01:13:28.639482+00:00",
"suggested_user_id": "cc17ee16-72df-4192-bc87-2c9491bd80e7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "40785190-602a-402b-9a51-cae62c47d11d",
"db_language_id": "511497cb-cf8e-4935-aa10-ee5908e09501",
"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-28T01:13:28.639482+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ffb2911e-a3d5-4e6f-b2c8-bc7c1b075c7b",
"sales_organization": {
"id": "5ca7f440-a30f-4017-8e9b-7e3b0eed1fe1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5fbf0b6a-eebd-4592-9d0e-db6fea0705d0",
"db_currency_id": "980cc745-c8f3-4efa-90a5-d79972319939",
"db_language_id": "b6612e48-e8d3-438c-918b-6145ae423b1c",
"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-28T01:13:28.639482+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1a876970-ec5b-4da2-b986-c837524a7386",
"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": "306b39f2-29c4-4785-8efa-e2093afc374d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-28T01:13:28.639482+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2d403f5e-d1e6-45c1-a284-a772d1e832d9"
},
"suggested_date_start": "2026-09-28T01:13:28.639482+00:00",
"skill_id": "ab5fbd63-0b89-4ae3-b764-953d7b23dd34",
"skill_code": "sample string 32",
"skill": {
"id": "c6293032-37be-4655-a28a-4644563420dc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "70e56d62-8016-4429-bb0d-40a8a84441e1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5ca7f440-a30f-4017-8e9b-7e3b0eed1fe1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5fbf0b6a-eebd-4592-9d0e-db6fea0705d0",
"db_currency_id": "980cc745-c8f3-4efa-90a5-d79972319939",
"db_language_id": "b6612e48-e8d3-438c-918b-6145ae423b1c",
"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-28T01:13:28.639482+00:00"
},
"modified_dateutc": "2026-09-28T01:13:28.639482+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8502bae9-eae2-4768-96f6-37fc6f60d486",
"date_reported_by_company": "2026-09-28T01:13:28.639482+00:00",
"id2": 36,
"company_id": "3812183d-62e6-49b0-aae2-8ad5e6de440f",
"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": "76979939-4a60-4774-9859-fdb4ab4ac70c",
"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-28T01:13:28.639482+00:00"
},
"work_instruction_details_id": "56eda889-0fae-493e-a045-4722c127beaa",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4c21a496-41b8-42ef-8e5b-573fa46fcaa3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bbdada7a-2028-4964-9abf-a7d595dc2b4a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-28T01:13:28.639482+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": "5e3c2c50-171e-45f9-bbe5-91642e31b48a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-28T01:13:28.639482+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.