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": "3bea4eb3-1f64-44e1-8668-a800ffe03443",
"jobs_id": "4e1c93b9-a3ca-4018-83c8-b88564d7cfe6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e6b635c7-52dc-4a01-b021-1a0413482c9b",
"_parent_id": "479ec85b-ba17-4eb9-87c3-eea91322ebfb",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f90e5bab-a615-4adc-9ec0-69f20a86683f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9feda641-29d3-412c-9c50-364776770690",
"_parent_id": "66d0f14b-9038-462d-8c86-2101616e2f3b",
"root_parent_id": "150a617a-121e-4b3f-9858-7d5ef7e26377",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "293984b7-bfbd-4a33-9969-1b8f1a8a89d8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "bc46c994-378a-421f-a734-e30cf978848a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "539f8d95-b789-467c-b51b-9fe97a3696af",
"_parent_code": "sample string 6",
"sales_organization_id": "b356a78a-c693-4788-88ba-e42bbcf43043",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1e602410-c1eb-46e5-a652-183d226d16cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ad88ac01-b7dc-4108-9f2f-999d9435e5b1",
"db_currency_id": "b7e17284-aac5-4a5c-8a58-d9984f600b75",
"db_language_id": "53710c8b-7fde-4c5b-8f8b-34288cd8921e",
"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-20T06:19:14.9855843+00:00"
},
"modified_dateutc": "2025-11-20T06:19:14.9855843+00:00"
},
"equipment_model_id": "b8149122-eb1b-4865-98bc-c96049d3303c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a72a51d3-0d36-4370-beec-519f9fddec83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1c009e04-04a9-44a8-9b2d-797627a09062",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "93d5adc5-3815-469b-b4cd-c9074de7f8d3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d98abcf4-4d4c-4a12-85c8-66e5b86e1f11",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1e602410-c1eb-46e5-a652-183d226d16cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ad88ac01-b7dc-4108-9f2f-999d9435e5b1",
"db_currency_id": "b7e17284-aac5-4a5c-8a58-d9984f600b75",
"db_language_id": "53710c8b-7fde-4c5b-8f8b-34288cd8921e",
"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-20T06:19:14.9855843+00:00"
},
"modified_dateutc": "2025-11-20T06:19:14.9855843+00:00"
},
"equipment_family_id": "54e6261a-3f19-4ff6-8aaf-fc2d986570f5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "bc46c994-378a-421f-a734-e30cf978848a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "539f8d95-b789-467c-b51b-9fe97a3696af",
"_parent_code": "sample string 6",
"sales_organization_id": "b356a78a-c693-4788-88ba-e42bbcf43043",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1e602410-c1eb-46e5-a652-183d226d16cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ad88ac01-b7dc-4108-9f2f-999d9435e5b1",
"db_currency_id": "b7e17284-aac5-4a5c-8a58-d9984f600b75",
"db_language_id": "53710c8b-7fde-4c5b-8f8b-34288cd8921e",
"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-20T06:19:14.9855843+00:00"
},
"modified_dateutc": "2025-11-20T06:19:14.9855843+00:00"
},
"date_in_production_since": "2025-11-20T06:19:14.9855843+00:00",
"date_out_of_production_since": "2025-11-20T06:19:14.9855843+00:00",
"date_end_support": "2025-11-20T06:19:14.9855843+00:00",
"sales_organization_id": "10d27cdc-48ab-41d9-bf47-4d6782d3592a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1e602410-c1eb-46e5-a652-183d226d16cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ad88ac01-b7dc-4108-9f2f-999d9435e5b1",
"db_currency_id": "b7e17284-aac5-4a5c-8a58-d9984f600b75",
"db_language_id": "53710c8b-7fde-4c5b-8f8b-34288cd8921e",
"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-20T06:19:14.9855843+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-20T06:19:14.9855843+00:00"
},
"project_status_id": "a36ce79b-58a5-4a7a-8bb2-e6f400ea9256",
"project_status_code": "sample string 10",
"project_status": {
"id": "57131107-d6f4-42ff-91af-d773d5141214",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fe7d1c99-f7a5-4e86-975c-c2d96e5ffc84",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1e602410-c1eb-46e5-a652-183d226d16cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ad88ac01-b7dc-4108-9f2f-999d9435e5b1",
"db_currency_id": "b7e17284-aac5-4a5c-8a58-d9984f600b75",
"db_language_id": "53710c8b-7fde-4c5b-8f8b-34288cd8921e",
"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-20T06:19:14.9855843+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-20T06:19:14.9855843+00:00"
},
"company_id": "fca7fd9f-c3bb-4074-9c4a-206dec80362f",
"company_code": "sample string 12",
"db_address_id": "ba448178-a0a2-4b7f-8cc7-0351ea46a31a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5b3776f2-e8c4-4864-88ed-8085f5ca42ec",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b91d7e3b-3701-47e1-a174-ca4676bd169c",
"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-20T06:19:14.9855843+00:00",
"date_create": "2025-11-20T06:19:14.9855843+00:00",
"date_update": "2025-11-20T06:19:14.9855843+00:00",
"updated_by_user_id": "ceaf6c34-bec8-4a73-a5ff-f4e9b12b0a80",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-20T06:19:14.9855843+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-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-20T06:19:14.9855843+00:00",
"date_last_job": "2025-11-20T06:19:14.9855843+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-20T06:19:14.9855843+00:00",
"modified_dateutc": "2025-11-20T06:19:14.9855843+00:00",
"is_mobile_installation": true
},
"job_type_id": "39b94887-6b42-4b5e-869a-01524036978e",
"job_type_code": "sample string 7",
"job_type": {
"id": "e179a639-112e-4148-b35f-378c0fd9a286",
"name": "sample string 2",
"sales_organization_id": "fcbf7f4a-3725-4510-827e-fa6f72e5cc3d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-20T06:19:14.9855843+00:00",
"code": "sample string 7"
},
"job_priority_id": "d12b31a8-c7cd-473f-b692-647152ed198a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "caa1416a-c191-4fba-8219-e17a359946c2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "48b4d363-1ac8-4242-9231-58398ac8a9b2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1e602410-c1eb-46e5-a652-183d226d16cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ad88ac01-b7dc-4108-9f2f-999d9435e5b1",
"db_currency_id": "b7e17284-aac5-4a5c-8a58-d9984f600b75",
"db_language_id": "53710c8b-7fde-4c5b-8f8b-34288cd8921e",
"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-20T06:19:14.9855843+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-20T06:19:14.9855843+00:00"
},
"job_status_id": "a198e0a0-0f7c-482f-a3ac-5cafcd03933b",
"job_status_code": "sample string 11",
"db_address_id": "b7937ff6-f5a5-4adc-8fb6-88e9331a551c",
"contact_id": "4a0696e6-7b58-4a33-900b-c2636d795cdd",
"requested_by_company_id": "e66a62f6-5299-4e94-9298-2f90ed9bd29f",
"requested_by_contact_id": "b3a2e592-4db9-4071-97e6-3559d883248d",
"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-20T06:19:14.9855843+00:00",
"due_date": "2025-11-20T06:19:14.9855843+00:00",
"date_create": "2025-11-20T06:19:14.9855843+00:00",
"date_update": "2025-11-20T06:19:14.9855843+00:00",
"date_closed": "2025-11-20T06:19:14.9855843+00:00",
"suggested_user_id": "c38c2795-54c1-4a37-8b89-fd54fad11156",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "95c395f1-a824-4e78-9958-d40fa9692979",
"db_language_id": "f73f9439-d0e2-44cd-a158-80e8a19643fc",
"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-20T06:19:14.9855843+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "fca192c0-180c-4f74-8203-ba377a651782",
"sales_organization": {
"id": "1e602410-c1eb-46e5-a652-183d226d16cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ad88ac01-b7dc-4108-9f2f-999d9435e5b1",
"db_currency_id": "b7e17284-aac5-4a5c-8a58-d9984f600b75",
"db_language_id": "53710c8b-7fde-4c5b-8f8b-34288cd8921e",
"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-20T06:19:14.9855843+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "309208a0-d02a-4317-a2d4-9bb94133cba0",
"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": "19d36224-3bf3-4d77-96f2-2b4bee95f302",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-20T06:19:14.9855843+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3cf07437-7ed5-4904-823a-e1398db34bd3"
},
"suggested_date_start": "2025-11-20T06:19:14.9855843+00:00",
"skill_id": "9a567470-b986-471c-8270-6077bdbd980f",
"skill_code": "sample string 32",
"skill": {
"id": "f74c5eed-be44-4ef6-ab35-03b0bd584f6c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "392f4e7b-69a9-4dbc-a524-849a918566b7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1e602410-c1eb-46e5-a652-183d226d16cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ad88ac01-b7dc-4108-9f2f-999d9435e5b1",
"db_currency_id": "b7e17284-aac5-4a5c-8a58-d9984f600b75",
"db_language_id": "53710c8b-7fde-4c5b-8f8b-34288cd8921e",
"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-20T06:19:14.9855843+00:00"
},
"modified_dateutc": "2025-11-20T06:19:14.9855843+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "804e6fee-cf85-4ee4-8a6e-cf885d379a8c",
"date_reported_by_company": "2025-11-20T06:19:14.9855843+00:00",
"id2": 36,
"company_id": "ca188fb0-b785-4266-b6d8-6fac6a040e56",
"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": "29887f64-b080-4be2-bdfb-a4e109de3f6a",
"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-20T06:19:14.9855843+00:00"
},
"work_instruction_details_id": "08efc64a-0170-4344-b7ec-7f271df3b8eb",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5da62371-52f5-43ed-8321-9d607c77efeb",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "09d6d83b-1086-4a75-b2ee-b43255f16440",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-20T06:19:14.9855843+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": "8906026c-8caa-4247-b0f0-d200ac387700",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-20T06:19:14.9855843+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.