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": "71706679-39ec-40a7-bdbf-3a7527ab7cce",
"jobs_id": "9cb88ec8-a2fd-4bd1-84ed-5449635c941e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f035add5-a6bc-4b02-acb5-9bae5d92b1e3",
"_parent_id": "14c0b519-007d-41ef-83fb-bca2ab78bf20",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "319b0bec-a521-4104-941a-ddc97ec7ba90",
"project_reference_back_office": "sample string 5",
"project": {
"id": "91e4682c-e9d0-467e-a632-d279b9fb5c99",
"_parent_id": "b95da813-3cce-4fd7-a5a3-98ce983e2473",
"root_parent_id": "f0c45ce8-4c87-430a-858f-d76433fd1fca",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "594f3e74-dd34-4551-a5ea-4551cae26fab",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "df5bf133-baba-4c15-aaa4-aa5aee3f447f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c9e04b9e-039b-4039-ab0f-d9dd17ea78c7",
"_parent_code": "sample string 6",
"sales_organization_id": "daade8fd-14db-439d-8e93-c33e0d62ef5e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "29df84ad-a7f5-4c04-b63c-2519ad7024c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86d0533d-e658-401f-bbeb-0e0d68a2d461",
"db_currency_id": "244561dd-c193-4c19-9637-dd5d21cde00c",
"db_language_id": "d5e0fa26-4203-4616-85db-cbf879632566",
"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-12-29T17:50:25.8429114+00:00"
},
"modified_dateutc": "2025-12-29T17:50:25.8429114+00:00"
},
"equipment_model_id": "08ce8386-ba56-4f37-964b-dcdb50f7ca54",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a6869337-22ee-4e7d-a94e-aa9407ac53a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4ac80e9a-7c80-4914-aefc-9ea9bf078fde",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a86562ac-0421-45cf-868d-a163011fe352",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3a2e018f-df51-44a3-881b-48e6eec5f50e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "29df84ad-a7f5-4c04-b63c-2519ad7024c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86d0533d-e658-401f-bbeb-0e0d68a2d461",
"db_currency_id": "244561dd-c193-4c19-9637-dd5d21cde00c",
"db_language_id": "d5e0fa26-4203-4616-85db-cbf879632566",
"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-12-29T17:50:25.8429114+00:00"
},
"modified_dateutc": "2025-12-29T17:50:25.8429114+00:00"
},
"equipment_family_id": "9ab0e228-e12c-4058-a1ea-3ec876acbcdb",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "df5bf133-baba-4c15-aaa4-aa5aee3f447f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c9e04b9e-039b-4039-ab0f-d9dd17ea78c7",
"_parent_code": "sample string 6",
"sales_organization_id": "daade8fd-14db-439d-8e93-c33e0d62ef5e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "29df84ad-a7f5-4c04-b63c-2519ad7024c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86d0533d-e658-401f-bbeb-0e0d68a2d461",
"db_currency_id": "244561dd-c193-4c19-9637-dd5d21cde00c",
"db_language_id": "d5e0fa26-4203-4616-85db-cbf879632566",
"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-12-29T17:50:25.8429114+00:00"
},
"modified_dateutc": "2025-12-29T17:50:25.8429114+00:00"
},
"date_in_production_since": "2025-12-29T17:50:25.8429114+00:00",
"date_out_of_production_since": "2025-12-29T17:50:25.8429114+00:00",
"date_end_support": "2025-12-29T17:50:25.8429114+00:00",
"sales_organization_id": "ad23e90b-266f-473e-89d0-ef3e8fce1d9d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "29df84ad-a7f5-4c04-b63c-2519ad7024c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86d0533d-e658-401f-bbeb-0e0d68a2d461",
"db_currency_id": "244561dd-c193-4c19-9637-dd5d21cde00c",
"db_language_id": "d5e0fa26-4203-4616-85db-cbf879632566",
"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-12-29T17:50:25.8429114+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-12-29T17:50:25.8429114+00:00"
},
"project_status_id": "e11a6bcd-3399-4d85-aa2b-6343b23e070a",
"project_status_code": "sample string 10",
"project_status": {
"id": "6c53ef2e-7c99-418a-b61d-8e7080366e3e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2a8d9a65-16c7-4009-9fd7-856e65cd0049",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "29df84ad-a7f5-4c04-b63c-2519ad7024c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86d0533d-e658-401f-bbeb-0e0d68a2d461",
"db_currency_id": "244561dd-c193-4c19-9637-dd5d21cde00c",
"db_language_id": "d5e0fa26-4203-4616-85db-cbf879632566",
"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-12-29T17:50:25.8429114+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-29T17:50:25.8429114+00:00"
},
"company_id": "7f148289-4152-401a-9ee6-60b3e9eb054a",
"company_code": "sample string 12",
"db_address_id": "5a0baaaa-c1f4-4e78-80fb-7290c67a916c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4e97b5df-6d2f-4da5-934c-f65a71a1dd26",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bb40849e-c681-48a6-bb0f-fa4ae9d928f6",
"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-12-29T17:50:25.8429114+00:00",
"date_create": "2025-12-29T17:50:25.8429114+00:00",
"date_update": "2025-12-29T17:50:25.8429114+00:00",
"updated_by_user_id": "12bab3bf-344a-4061-9315-0a1378a43244",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-29T17:50:25.8429114+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-12-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-29T17:50:25.8429114+00:00",
"date_last_job": "2025-12-29T17:50:25.8429114+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-29T17:50:25.8429114+00:00",
"modified_dateutc": "2025-12-29T17:50:25.8429114+00:00",
"is_mobile_installation": true
},
"job_type_id": "40dafed9-e3c4-4591-bbca-4ffd1ed421f3",
"job_type_code": "sample string 7",
"job_type": {
"id": "1b703a48-9448-4ed2-a26b-3a011abd50d2",
"name": "sample string 2",
"sales_organization_id": "5c1544eb-63d6-408c-911c-ac23f7ce70da",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-29T17:50:25.8429114+00:00",
"code": "sample string 7"
},
"job_priority_id": "4a5693c6-4c1f-483e-990d-ee348950624e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "705bede5-d765-416a-94ba-fe874687ce36",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "181ed490-24f8-4c1e-8643-038b329f88ac",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "29df84ad-a7f5-4c04-b63c-2519ad7024c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86d0533d-e658-401f-bbeb-0e0d68a2d461",
"db_currency_id": "244561dd-c193-4c19-9637-dd5d21cde00c",
"db_language_id": "d5e0fa26-4203-4616-85db-cbf879632566",
"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-12-29T17:50:25.8429114+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-29T17:50:25.8585358+00:00"
},
"job_status_id": "7f8ed6d4-b245-4d48-86a7-e07cdcb39333",
"job_status_code": "sample string 11",
"db_address_id": "eb5845b7-6c40-44e7-8e4f-942296e36689",
"contact_id": "2b16854e-355e-48a2-b2a2-5e84a6df8af8",
"requested_by_company_id": "680acdbf-b57f-43b4-add2-d08e55513928",
"requested_by_contact_id": "3fe00989-8b64-444b-85c7-dd1eaaaed459",
"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-12-29T17:50:25.8585358+00:00",
"due_date": "2025-12-29T17:50:25.8585358+00:00",
"date_create": "2025-12-29T17:50:25.8585358+00:00",
"date_update": "2025-12-29T17:50:25.8585358+00:00",
"date_closed": "2025-12-29T17:50:25.8585358+00:00",
"suggested_user_id": "04886479-0e30-4ae4-8615-93d86527def6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "83a5351c-bdad-4994-a37a-6d6b0d301b3a",
"db_language_id": "e9707a6c-b223-4769-b1fb-e822658c7c57",
"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-12-29T17:50:25.8585358+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ab86a2f8-fc23-43c9-b329-c81c630d7c3e",
"sales_organization": {
"id": "29df84ad-a7f5-4c04-b63c-2519ad7024c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86d0533d-e658-401f-bbeb-0e0d68a2d461",
"db_currency_id": "244561dd-c193-4c19-9637-dd5d21cde00c",
"db_language_id": "d5e0fa26-4203-4616-85db-cbf879632566",
"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-12-29T17:50:25.8429114+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f38bbcbf-6d54-4d11-ac78-0bc652c11e0b",
"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": "58c110ca-7f52-42e4-beaf-2c1bf3908b8c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-29T17:50:25.8585358+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "95dc04ee-aeec-4b7a-9cb7-34394416666e"
},
"suggested_date_start": "2025-12-29T17:50:25.8585358+00:00",
"skill_id": "c6b42c35-cbd3-4664-95d4-8ba3c9c07b32",
"skill_code": "sample string 32",
"skill": {
"id": "df4223a2-e57a-4fbd-936d-572792a16c4c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f6bc697f-a7a0-42ae-a3dc-714fb5c3b55a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "29df84ad-a7f5-4c04-b63c-2519ad7024c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86d0533d-e658-401f-bbeb-0e0d68a2d461",
"db_currency_id": "244561dd-c193-4c19-9637-dd5d21cde00c",
"db_language_id": "d5e0fa26-4203-4616-85db-cbf879632566",
"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-12-29T17:50:25.8429114+00:00"
},
"modified_dateutc": "2025-12-29T17:50:25.8585358+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b84a0ba6-3f0c-4244-9732-073b2d6008b5",
"date_reported_by_company": "2025-12-29T17:50:25.8585358+00:00",
"id2": 36,
"company_id": "aa7ba12b-1934-47b3-a276-dee86dd4597d",
"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": "197b4cd2-2bf8-4ee9-82be-e0fae31e5fa1",
"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-12-29T17:50:25.8585358+00:00"
},
"work_instruction_details_id": "2dacee42-8883-4437-9e09-9194649ebec5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "44370773-37ea-41bc-a7e0-fd1b77495f6d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c0958c9a-7885-485f-9fe7-74a43078b71c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-29T17:50:25.8585358+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": "920c422b-cfa2-4ef7-b31e-85d489794f91",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-29T17:50:25.8585358+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.