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": "2813d4a2-9ae1-4789-8a46-9df07f8b997c",
"jobs_id": "b46f5e98-c2c2-418a-a084-c4998269cd0c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c74380ef-1ca0-4550-9167-0237d9c30ed5",
"_parent_id": "4d95b836-d433-43b5-b3bb-eb1a5ed9ba56",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e002f11b-5e27-445f-a05b-714af1469846",
"project_reference_back_office": "sample string 5",
"project": {
"id": "de403d39-e126-4036-8826-ef34c0c3fdab",
"_parent_id": "1fd52f3c-8a7c-4b54-a582-b333970aafa9",
"root_parent_id": "1660a8de-7baa-4fff-9fa4-e007d6aefb05",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "515565e9-096e-4d27-ac83-26c66fe5af5a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2abb964e-7385-4231-a464-b9b421f5d575",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d1a97178-e9ef-4661-a587-4d77662b60f9",
"_parent_code": "sample string 6",
"sales_organization_id": "5d0127f2-87d4-4a4c-b76c-7f75d0ac0a25",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1a9a4d5c-bf36-4b17-a97b-32978859f32e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4cc3157-e413-4583-ae3d-651621461599",
"db_currency_id": "10d9d875-2844-472c-9cd2-8ea0547f3028",
"db_language_id": "04cdc3b9-535e-4190-863e-56d2c99e1faa",
"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-23T13:29:48.0823442+00:00"
},
"modified_dateutc": "2026-09-23T13:29:48.0823442+00:00"
},
"equipment_model_id": "d95229bb-c11e-4475-8601-dd07f75a5b7e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "26edef81-20a6-4a50-892a-0fe3439af305",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6eeaf254-4188-4eca-840e-469fd64ef210",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5ba291a1-8909-49d8-be49-bb74e9cddeb2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "327f9054-9e82-471a-8fd5-252c80511747",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1a9a4d5c-bf36-4b17-a97b-32978859f32e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4cc3157-e413-4583-ae3d-651621461599",
"db_currency_id": "10d9d875-2844-472c-9cd2-8ea0547f3028",
"db_language_id": "04cdc3b9-535e-4190-863e-56d2c99e1faa",
"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-23T13:29:48.0823442+00:00"
},
"modified_dateutc": "2026-09-23T13:29:48.0823442+00:00"
},
"equipment_family_id": "096cb335-ce0d-4e45-b748-0eb5204a0f6f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2abb964e-7385-4231-a464-b9b421f5d575",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d1a97178-e9ef-4661-a587-4d77662b60f9",
"_parent_code": "sample string 6",
"sales_organization_id": "5d0127f2-87d4-4a4c-b76c-7f75d0ac0a25",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1a9a4d5c-bf36-4b17-a97b-32978859f32e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4cc3157-e413-4583-ae3d-651621461599",
"db_currency_id": "10d9d875-2844-472c-9cd2-8ea0547f3028",
"db_language_id": "04cdc3b9-535e-4190-863e-56d2c99e1faa",
"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-23T13:29:48.0823442+00:00"
},
"modified_dateutc": "2026-09-23T13:29:48.0823442+00:00"
},
"date_in_production_since": "2026-09-23T13:29:48.0823442+00:00",
"date_out_of_production_since": "2026-09-23T13:29:48.0823442+00:00",
"date_end_support": "2026-09-23T13:29:48.0823442+00:00",
"sales_organization_id": "12e5fd13-0a3b-4cf4-92b9-febe115c4d17",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1a9a4d5c-bf36-4b17-a97b-32978859f32e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4cc3157-e413-4583-ae3d-651621461599",
"db_currency_id": "10d9d875-2844-472c-9cd2-8ea0547f3028",
"db_language_id": "04cdc3b9-535e-4190-863e-56d2c99e1faa",
"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-23T13:29:48.0823442+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-23T13:29:48.0823442+00:00"
},
"project_status_id": "bc41efbc-85d8-4657-8d2f-8b534dfc5549",
"project_status_code": "sample string 10",
"project_status": {
"id": "e7bcc251-7153-4294-a50e-75b92b965d79",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a3bade21-4231-4c07-93e6-90aacc5b687f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1a9a4d5c-bf36-4b17-a97b-32978859f32e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4cc3157-e413-4583-ae3d-651621461599",
"db_currency_id": "10d9d875-2844-472c-9cd2-8ea0547f3028",
"db_language_id": "04cdc3b9-535e-4190-863e-56d2c99e1faa",
"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-23T13:29:48.0823442+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-23T13:29:48.0823442+00:00"
},
"company_id": "810aac08-20da-4476-a05a-02dab592f24e",
"company_code": "sample string 12",
"db_address_id": "acffa549-ae82-4adc-9e91-dc20a0200f29",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f8536ac0-5d70-4d29-ad3a-31f7e73458f7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3f36b59e-a93d-42af-a051-b87cbd429a7f",
"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-23T13:29:48.0823442+00:00",
"date_create": "2026-09-23T13:29:48.0823442+00:00",
"date_update": "2026-09-23T13:29:48.0823442+00:00",
"updated_by_user_id": "9c86cc1c-bf2c-49e7-8c03-3ce92f640941",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-23T13:29:48.0823442+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-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-23T13:29:48.0823442+00:00",
"date_last_job": "2026-09-23T13:29:48.0823442+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-23T13:29:48.0823442+00:00",
"modified_dateutc": "2026-09-23T13:29:48.0823442+00:00",
"is_mobile_installation": true
},
"job_type_id": "05287559-ff4d-4ff0-8c95-97be7d00fa63",
"job_type_code": "sample string 7",
"job_type": {
"id": "385e9c9a-8753-4a17-8712-f782dd48dbb9",
"name": "sample string 2",
"sales_organization_id": "2b352f51-a5ed-4e14-bf78-368ce7b42509",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-23T13:29:48.0823442+00:00",
"code": "sample string 7"
},
"job_priority_id": "4c45432c-6327-41b7-82bf-0d1e5e7328ac",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6660b575-a1a7-44bc-8a2d-a256d5b0fa13",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "105a9da8-5b8d-494c-a74f-8ac8b55a35d2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1a9a4d5c-bf36-4b17-a97b-32978859f32e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4cc3157-e413-4583-ae3d-651621461599",
"db_currency_id": "10d9d875-2844-472c-9cd2-8ea0547f3028",
"db_language_id": "04cdc3b9-535e-4190-863e-56d2c99e1faa",
"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-23T13:29:48.0823442+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-23T13:29:48.0823442+00:00"
},
"job_status_id": "10806b5b-eb70-4519-9346-3ef45c8a87d6",
"job_status_code": "sample string 11",
"db_address_id": "bf201009-d2ae-42e3-9b55-c2068d1c65e3",
"contact_id": "b9c19183-0d7d-44bf-ab10-486eab5a03fc",
"requested_by_company_id": "b6c8f286-cce6-4769-b534-aee071cd1154",
"requested_by_contact_id": "67fd5d7f-568e-435f-81d8-c4335800f9d6",
"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-23T13:29:48.0823442+00:00",
"due_date": "2026-09-23T13:29:48.0823442+00:00",
"date_create": "2026-09-23T13:29:48.0823442+00:00",
"date_update": "2026-09-23T13:29:48.0823442+00:00",
"date_closed": "2026-09-23T13:29:48.0823442+00:00",
"suggested_user_id": "6346eab9-ed9f-432f-a416-171d22c0db5b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1c1e5133-6d34-46a0-8ff3-a20c7ea81f0d",
"db_language_id": "e63b89a3-fd64-4c70-8e2e-503687a839cf",
"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-23T13:29:48.0823442+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "04dfd415-5e05-4896-9d72-7873a0db4462",
"sales_organization": {
"id": "1a9a4d5c-bf36-4b17-a97b-32978859f32e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4cc3157-e413-4583-ae3d-651621461599",
"db_currency_id": "10d9d875-2844-472c-9cd2-8ea0547f3028",
"db_language_id": "04cdc3b9-535e-4190-863e-56d2c99e1faa",
"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-23T13:29:48.0823442+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c6428861-370b-4342-beea-75487aa4cc5c",
"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": "4a70c14f-eb84-48f0-b7d2-3242c6dca40e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-23T13:29:48.0823442+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "442834eb-ed59-44b0-8cdb-d011cdc4cfe7"
},
"suggested_date_start": "2026-09-23T13:29:48.0823442+00:00",
"skill_id": "0fcd486e-d84f-43b3-9518-9941a6a1a4f5",
"skill_code": "sample string 32",
"skill": {
"id": "7050faec-e958-40a7-b336-37f4ded7583d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2c40ebcf-5f83-4014-b7c5-150e69de494c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1a9a4d5c-bf36-4b17-a97b-32978859f32e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4cc3157-e413-4583-ae3d-651621461599",
"db_currency_id": "10d9d875-2844-472c-9cd2-8ea0547f3028",
"db_language_id": "04cdc3b9-535e-4190-863e-56d2c99e1faa",
"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-23T13:29:48.0823442+00:00"
},
"modified_dateutc": "2026-09-23T13:29:48.0823442+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9f63f062-76fd-49b1-b236-6f118ee08345",
"date_reported_by_company": "2026-09-23T13:29:48.0823442+00:00",
"id2": 36,
"company_id": "72c7aa22-ebd7-471c-bbe1-d6ad56a682f0",
"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": "e939d001-5236-437f-b640-3bdffa4cbb75",
"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-23T13:29:48.0823442+00:00"
},
"work_instruction_details_id": "1d09df10-129e-4596-86de-170d3739b34a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "358291fa-fd47-4c98-8b0d-149ae2abc922",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "79d7caca-d9ce-4ce1-8d18-5e1ca4f6fa9d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-23T13:29:48.0823442+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": "f946b445-5f68-442e-a2b3-d95903f0f21e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-23T13:29:48.0823442+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.