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": "21d53023-c243-47f9-9593-61781b5622ef",
"jobs_id": "7f62995b-354d-4f01-8298-fc17d9f4491f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7388d1ba-8c09-4d39-b365-b8d87628b0a7",
"_parent_id": "512862d4-6777-4919-a411-4175f81937d2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "082a3f82-fb83-4215-aee0-82af24ae0856",
"project_reference_back_office": "sample string 5",
"project": {
"id": "22aea430-b421-48ab-9b81-2ea13f391faf",
"_parent_id": "99573f3b-da1f-4204-83de-a49ea7583390",
"root_parent_id": "b596e3b7-4c51-4826-bd14-2d86b1133f0a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ba9745fd-ee0b-471c-87b5-e2cb840dbdb6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "fb6f23fa-402f-4eb4-8af6-6af83c346b46",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "198cb24b-6473-4e0d-9b34-d00344bc5396",
"_parent_code": "sample string 6",
"sales_organization_id": "22ff95e3-19ec-4630-9140-41882859a652",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "918d27b6-07d9-41d4-9861-3d1e6e3eccca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e1919ec4-f4fe-47ba-9888-ca58e244158b",
"db_currency_id": "490d40dd-2eac-405b-9eb0-8b0f0bea01ed",
"db_language_id": "57b6ea3a-5c14-4050-8b9d-c0b6ba98da71",
"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": "2025-11-24T14:23:59.3143546+00:00"
},
"modified_dateutc": "2025-11-24T14:23:59.3143546+00:00"
},
"equipment_model_id": "eab05e17-66d5-4733-9e83-65dcf25412a5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2baccb81-636e-469a-8997-2df8d6ee4e8c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "392cfa7f-af90-4227-9323-3e8224c5feb5",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8a16fb40-ae0c-4e04-8c8b-3803a6b1b354",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f190a080-387d-4cc9-b879-574f22e86061",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "918d27b6-07d9-41d4-9861-3d1e6e3eccca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e1919ec4-f4fe-47ba-9888-ca58e244158b",
"db_currency_id": "490d40dd-2eac-405b-9eb0-8b0f0bea01ed",
"db_language_id": "57b6ea3a-5c14-4050-8b9d-c0b6ba98da71",
"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": "2025-11-24T14:23:59.3143546+00:00"
},
"modified_dateutc": "2025-11-24T14:23:59.3143546+00:00"
},
"equipment_family_id": "543ac024-4de3-4eda-8190-bd3337e8042f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "fb6f23fa-402f-4eb4-8af6-6af83c346b46",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "198cb24b-6473-4e0d-9b34-d00344bc5396",
"_parent_code": "sample string 6",
"sales_organization_id": "22ff95e3-19ec-4630-9140-41882859a652",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "918d27b6-07d9-41d4-9861-3d1e6e3eccca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e1919ec4-f4fe-47ba-9888-ca58e244158b",
"db_currency_id": "490d40dd-2eac-405b-9eb0-8b0f0bea01ed",
"db_language_id": "57b6ea3a-5c14-4050-8b9d-c0b6ba98da71",
"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": "2025-11-24T14:23:59.3143546+00:00"
},
"modified_dateutc": "2025-11-24T14:23:59.3143546+00:00"
},
"date_in_production_since": "2025-11-24T14:23:59.3143546+00:00",
"date_out_of_production_since": "2025-11-24T14:23:59.3143546+00:00",
"date_end_support": "2025-11-24T14:23:59.3143546+00:00",
"sales_organization_id": "6e56e55c-961c-4b38-9d4a-7f7540078c05",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "918d27b6-07d9-41d4-9861-3d1e6e3eccca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e1919ec4-f4fe-47ba-9888-ca58e244158b",
"db_currency_id": "490d40dd-2eac-405b-9eb0-8b0f0bea01ed",
"db_language_id": "57b6ea3a-5c14-4050-8b9d-c0b6ba98da71",
"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": "2025-11-24T14:23:59.3143546+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": "2025-11-24T14:23:59.3143546+00:00"
},
"project_status_id": "aeed4239-3a10-4968-9e03-f035a690662a",
"project_status_code": "sample string 10",
"project_status": {
"id": "1b5e9e7b-fbc9-4eea-8b49-27ec82f65ca2",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1326c3e8-2f57-4710-a748-86434a2a0dc5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "918d27b6-07d9-41d4-9861-3d1e6e3eccca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e1919ec4-f4fe-47ba-9888-ca58e244158b",
"db_currency_id": "490d40dd-2eac-405b-9eb0-8b0f0bea01ed",
"db_language_id": "57b6ea3a-5c14-4050-8b9d-c0b6ba98da71",
"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": "2025-11-24T14:23:59.3143546+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-24T14:23:59.3143546+00:00"
},
"company_id": "c374cfec-4f1e-480b-b73d-86a6a1038331",
"company_code": "sample string 12",
"db_address_id": "5bf02c40-cc24-4d92-8dba-374cb1b1e7d0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "386f64d5-b71e-4340-8109-bb5fdd771e2d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "95ee7bbc-242f-4914-acf8-176fe980e6cb",
"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": "2025-11-24T14:23:59.3299783+00:00",
"date_create": "2025-11-24T14:23:59.3299783+00:00",
"date_update": "2025-11-24T14:23:59.3299783+00:00",
"updated_by_user_id": "d5d94434-b1d1-47c6-84e1-14d153d30189",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-24T14:23:59.3299783+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": "2025-11-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-24T14:23:59.3299783+00:00",
"date_last_job": "2025-11-24T14:23:59.3299783+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-24T14:23:59.3299783+00:00",
"modified_dateutc": "2025-11-24T14:23:59.3299783+00:00",
"is_mobile_installation": true
},
"job_type_id": "35d79e2c-ab84-4283-aa27-15ed415847f8",
"job_type_code": "sample string 7",
"job_type": {
"id": "8eb56014-0b84-47a3-8a79-5f5d4670e101",
"name": "sample string 2",
"sales_organization_id": "ebfe4b89-e5b6-45ca-b617-71a044d736b6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-24T14:23:59.3299783+00:00",
"code": "sample string 7"
},
"job_priority_id": "2a1f37db-81d7-4572-a09e-e66085c2d446",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "13d8f3cb-eee7-4035-ae6c-e7e0ec080b66",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "44343c7a-8ad1-48ed-acac-9a899261298e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "918d27b6-07d9-41d4-9861-3d1e6e3eccca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e1919ec4-f4fe-47ba-9888-ca58e244158b",
"db_currency_id": "490d40dd-2eac-405b-9eb0-8b0f0bea01ed",
"db_language_id": "57b6ea3a-5c14-4050-8b9d-c0b6ba98da71",
"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": "2025-11-24T14:23:59.3143546+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-24T14:23:59.3299783+00:00"
},
"job_status_id": "9f744c88-cd9e-43de-8f52-daeef6090164",
"job_status_code": "sample string 11",
"db_address_id": "53efb65b-9178-43ba-bae8-c8eaca4a0a79",
"contact_id": "cf8cfd53-97ab-44b3-a15a-5ee14515d978",
"requested_by_company_id": "0712ef9a-6950-41f7-a089-b4eba1c927fc",
"requested_by_contact_id": "3939dbeb-284a-4b91-a346-3278b2c2af4e",
"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": "2025-11-24T14:23:59.3299783+00:00",
"due_date": "2025-11-24T14:23:59.3299783+00:00",
"date_create": "2025-11-24T14:23:59.3299783+00:00",
"date_update": "2025-11-24T14:23:59.3299783+00:00",
"date_closed": "2025-11-24T14:23:59.3299783+00:00",
"suggested_user_id": "7031dc7d-fe93-4ef8-8393-3ff09178c14b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0466631e-a891-490f-baa3-ff97715388a4",
"db_language_id": "6ecb2e32-100d-4a79-a76e-41394866a4e4",
"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": "2025-11-24T14:23:59.3299783+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "abdc9af1-4a87-4324-aad4-a74ee6d07b87",
"sales_organization": {
"id": "918d27b6-07d9-41d4-9861-3d1e6e3eccca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e1919ec4-f4fe-47ba-9888-ca58e244158b",
"db_currency_id": "490d40dd-2eac-405b-9eb0-8b0f0bea01ed",
"db_language_id": "57b6ea3a-5c14-4050-8b9d-c0b6ba98da71",
"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": "2025-11-24T14:23:59.3143546+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f4c9e878-8c39-408b-81af-03999739ad5d",
"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": "dacd576a-36f4-42b3-a976-fd0fe4f1568b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-24T14:23:59.3299783+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d3ed7a67-5705-48e7-9ca3-7b064c509d86"
},
"suggested_date_start": "2025-11-24T14:23:59.3299783+00:00",
"skill_id": "4ee60965-8713-4cb4-8069-c29f5c5bc3a2",
"skill_code": "sample string 32",
"skill": {
"id": "cb85c777-d894-44f3-8d5a-4f798e55ee4e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "251e394a-c5d0-4346-afb3-84e4d80a8172",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "918d27b6-07d9-41d4-9861-3d1e6e3eccca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e1919ec4-f4fe-47ba-9888-ca58e244158b",
"db_currency_id": "490d40dd-2eac-405b-9eb0-8b0f0bea01ed",
"db_language_id": "57b6ea3a-5c14-4050-8b9d-c0b6ba98da71",
"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": "2025-11-24T14:23:59.3143546+00:00"
},
"modified_dateutc": "2025-11-24T14:23:59.3299783+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1c727bc8-f17b-4b55-99c9-09a21fd5e4d9",
"date_reported_by_company": "2025-11-24T14:23:59.3299783+00:00",
"id2": 36,
"company_id": "aca4719a-53f4-4890-8b13-edb22a5f6976",
"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": "05075abf-d670-4bba-9cb0-e7da3b844164",
"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": "2025-11-24T14:23:59.3299783+00:00"
},
"work_instruction_details_id": "aa901176-500f-48a1-8413-cde1bde332a9",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "11aa9efd-ac5b-401a-8142-b9f7c43aee89",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ff858b6b-8882-49eb-ba6f-a7301710b029",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-24T14:23:59.3299783+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": "5955ffb9-5a4f-4b04-81d8-4c24d4acda94",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-24T14:23:59.3299783+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.