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": "a7e3c912-d8d4-493a-adf8-62d960684106",
"jobs_id": "7d4db80a-47e8-4994-ba33-ba7992960729",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "20a00d57-0f6c-4d03-8b20-55ed9cd9652b",
"_parent_id": "211994ad-2996-436c-8371-310e3d089828",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "289421df-0218-477b-a2ab-d3a85a206487",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2bdabf90-87de-4158-8cc4-18ce151a9927",
"_parent_id": "be486023-b3fc-485e-bcd5-baca754edc92",
"root_parent_id": "3883d627-ac27-4729-b05c-a7385d2efb9b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8942ac8c-4977-49ca-b2b2-49a3fb35a48c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "cdd32b2b-e5eb-41f8-a594-f84994a78a5a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b5a444fa-fe4e-4cb7-a8e7-69bc736bc123",
"_parent_code": "sample string 6",
"sales_organization_id": "8561bd49-dcd3-4073-a52d-579661c51a52",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ba89ce06-eb26-48fb-8dab-c4c7506f147f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45214465-686a-4173-9e2b-f7c3d3b3c743",
"db_currency_id": "ca3d03f0-5b9f-4c14-aa31-4c3beb2c81d8",
"db_language_id": "24579f99-6210-4ff2-b247-7f6eb3d5ca18",
"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-11-04T16:44:24.8880881+00:00"
},
"modified_dateutc": "2026-11-04T16:44:24.8880881+00:00"
},
"equipment_model_id": "3b7cfb89-6592-4d95-ac43-5ec1a00923d1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8e0abb85-08e2-4907-bd21-9efed65b00ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "546224a4-e221-4eeb-8435-2749ed3bd479",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "500416e5-716d-4f9c-8e48-5b06b96a6e9e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d3511c26-369d-4eee-a763-1e8dc7cfc2e2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ba89ce06-eb26-48fb-8dab-c4c7506f147f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45214465-686a-4173-9e2b-f7c3d3b3c743",
"db_currency_id": "ca3d03f0-5b9f-4c14-aa31-4c3beb2c81d8",
"db_language_id": "24579f99-6210-4ff2-b247-7f6eb3d5ca18",
"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-11-04T16:44:24.8880881+00:00"
},
"modified_dateutc": "2026-11-04T16:44:24.8880881+00:00"
},
"equipment_family_id": "f0a1ef1a-a80f-4444-9267-f90d4652ce7b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "cdd32b2b-e5eb-41f8-a594-f84994a78a5a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b5a444fa-fe4e-4cb7-a8e7-69bc736bc123",
"_parent_code": "sample string 6",
"sales_organization_id": "8561bd49-dcd3-4073-a52d-579661c51a52",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ba89ce06-eb26-48fb-8dab-c4c7506f147f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45214465-686a-4173-9e2b-f7c3d3b3c743",
"db_currency_id": "ca3d03f0-5b9f-4c14-aa31-4c3beb2c81d8",
"db_language_id": "24579f99-6210-4ff2-b247-7f6eb3d5ca18",
"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-11-04T16:44:24.8880881+00:00"
},
"modified_dateutc": "2026-11-04T16:44:24.8880881+00:00"
},
"date_in_production_since": "2026-11-04T16:44:24.8880881+00:00",
"date_out_of_production_since": "2026-11-04T16:44:24.8880881+00:00",
"date_end_support": "2026-11-04T16:44:24.8880881+00:00",
"sales_organization_id": "d774e6be-3bd4-4e2c-89e4-943e2a33af0b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ba89ce06-eb26-48fb-8dab-c4c7506f147f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45214465-686a-4173-9e2b-f7c3d3b3c743",
"db_currency_id": "ca3d03f0-5b9f-4c14-aa31-4c3beb2c81d8",
"db_language_id": "24579f99-6210-4ff2-b247-7f6eb3d5ca18",
"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-11-04T16:44:24.8880881+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-11-04T16:44:24.8880881+00:00"
},
"project_status_id": "9525bc48-7843-413d-be9f-a01797bf5800",
"project_status_code": "sample string 10",
"project_status": {
"id": "ea3f9e1f-44c9-4458-8798-f931119a458e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ee01de0c-8999-4ecd-a31a-5c0fe651bc9e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ba89ce06-eb26-48fb-8dab-c4c7506f147f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45214465-686a-4173-9e2b-f7c3d3b3c743",
"db_currency_id": "ca3d03f0-5b9f-4c14-aa31-4c3beb2c81d8",
"db_language_id": "24579f99-6210-4ff2-b247-7f6eb3d5ca18",
"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-11-04T16:44:24.8880881+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-04T16:44:24.8880881+00:00"
},
"company_id": "e324a671-4f8a-4b5e-a912-bce05bed9500",
"company_code": "sample string 12",
"db_address_id": "61c3e25f-4302-4bf3-81ed-3ed78db9dcc0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "60cce55c-fe1c-46eb-9195-7465da2d91ba",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "247305d2-cb46-4b2d-bdec-871733037658",
"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-11-04T16:44:24.8880881+00:00",
"date_create": "2026-11-04T16:44:24.8880881+00:00",
"date_update": "2026-11-04T16:44:24.8880881+00:00",
"updated_by_user_id": "1801fe39-8b5e-4003-96ac-64a1fc8ab759",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-04T16:44:24.8880881+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-11-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-04T16:44:24.8880881+00:00",
"date_last_job": "2026-11-04T16:44:24.8880881+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-04T16:44:24.8880881+00:00",
"modified_dateutc": "2026-11-04T16:44:24.8880881+00:00",
"is_mobile_installation": true
},
"job_type_id": "c9f34d09-8389-48ab-adde-62c5cae50c3c",
"job_type_code": "sample string 7",
"job_type": {
"id": "b9270382-36b9-4c06-9132-fd74417aa194",
"name": "sample string 2",
"sales_organization_id": "cade0178-aee2-4a62-b7f4-5f464652cd6c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-04T16:44:24.8880881+00:00",
"code": "sample string 7"
},
"job_priority_id": "5ab7d838-5d6b-42ad-81bb-eaf5e1c296b4",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6f2118ed-b1a0-43dc-b2bc-939717f60e3e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "104b5a55-48a6-4040-866d-3546a9903d4a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ba89ce06-eb26-48fb-8dab-c4c7506f147f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45214465-686a-4173-9e2b-f7c3d3b3c743",
"db_currency_id": "ca3d03f0-5b9f-4c14-aa31-4c3beb2c81d8",
"db_language_id": "24579f99-6210-4ff2-b247-7f6eb3d5ca18",
"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-11-04T16:44:24.8880881+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-04T16:44:24.8880881+00:00"
},
"job_status_id": "6165ea78-fde6-4f41-8aea-56a3b8957aee",
"job_status_code": "sample string 11",
"db_address_id": "fe2afa63-fcaf-4e9f-a725-c7df4ef9c020",
"contact_id": "5c228e6c-8d9b-4bea-89a1-8dd03b66045d",
"requested_by_company_id": "f7326f1a-ea44-48d3-8016-90d7e1718a39",
"requested_by_contact_id": "f738a6ef-9ec9-4eb7-a7af-7aef89eeb2ab",
"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-11-04T16:44:24.8880881+00:00",
"due_date": "2026-11-04T16:44:24.8880881+00:00",
"date_create": "2026-11-04T16:44:24.8880881+00:00",
"date_update": "2026-11-04T16:44:24.8880881+00:00",
"date_closed": "2026-11-04T16:44:24.8880881+00:00",
"suggested_user_id": "c63dcf62-4e1a-4faa-a3f0-6213afb76192",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "08c556cb-e230-4940-9db6-17858cb9ef84",
"db_language_id": "62cfa57c-720f-406f-adbf-e27a459bee2d",
"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-11-04T16:44:24.8880881+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2e5680ff-bc55-4386-8364-e03688a2f0c7",
"sales_organization": {
"id": "ba89ce06-eb26-48fb-8dab-c4c7506f147f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45214465-686a-4173-9e2b-f7c3d3b3c743",
"db_currency_id": "ca3d03f0-5b9f-4c14-aa31-4c3beb2c81d8",
"db_language_id": "24579f99-6210-4ff2-b247-7f6eb3d5ca18",
"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-11-04T16:44:24.8880881+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f02a8138-3291-4641-a334-aa2f9cb84ea0",
"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": "b2bfbb03-8576-42aa-b52d-5701de176eef",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-04T16:44:24.8880881+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a4082b73-3d37-4f96-ac1a-c68360745467"
},
"suggested_date_start": "2026-11-04T16:44:24.8880881+00:00",
"skill_id": "1ccdca36-7136-404d-9d66-3a29730ad1ab",
"skill_code": "sample string 32",
"skill": {
"id": "b7b1e3f0-0db2-469f-b1c0-c65dddfdebf9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d08cbc47-4483-4d39-bcfd-41b23fe54d23",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ba89ce06-eb26-48fb-8dab-c4c7506f147f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45214465-686a-4173-9e2b-f7c3d3b3c743",
"db_currency_id": "ca3d03f0-5b9f-4c14-aa31-4c3beb2c81d8",
"db_language_id": "24579f99-6210-4ff2-b247-7f6eb3d5ca18",
"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-11-04T16:44:24.8880881+00:00"
},
"modified_dateutc": "2026-11-04T16:44:24.8880881+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "740b366e-b38b-4eb3-9d8e-b88c71ab0836",
"date_reported_by_company": "2026-11-04T16:44:24.8880881+00:00",
"id2": 36,
"company_id": "d314e87d-c83c-4f84-ac78-92505c1e002c",
"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": "78aa93fa-6a89-4880-8859-1b35d6686ad9",
"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-11-04T16:44:24.8880881+00:00"
},
"work_instruction_details_id": "6240f98c-83e7-4101-8d8f-060f24425043",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ba030fbe-4f72-4700-830a-75baa595f7f7",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bf0add49-3a65-4786-95d1-5feeea248d33",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-04T16:44:24.8880881+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": "428a8c9f-a5e5-480e-8549-ee1294662424",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-04T16:44:24.899259+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.