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": "ffae1201-2bb4-4fb7-9c4d-576d13d99e56",
"jobs_id": "90275fae-3f8e-42ef-8992-67cf8b657b9d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5cc5e8ab-1c6f-4911-a5f2-027a1f7f0286",
"_parent_id": "afbec96d-ccee-4acd-b2a6-639844fb438a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1f226095-772b-4e57-bd42-c0fad4068424",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8130d549-ed03-4980-a58e-1cd842826ab9",
"_parent_id": "674a8b28-898f-4c50-8a8a-48bd90e114a5",
"root_parent_id": "428b00e8-4aae-4027-8678-e15e4d1ba327",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ce534301-19c9-45b7-b482-25e3144c1b49",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b3cb3799-8996-41c6-b4e8-b33c96cae8d8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "af550223-d192-4b74-ac7f-77fae168ace8",
"_parent_code": "sample string 6",
"sales_organization_id": "760fbe42-f041-4519-ad3b-984dc2ec01cc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ccfec3b9-f859-44e4-b9d4-443850b0a8b0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "529320d0-1e4d-46c2-aaea-2cc236fe00f8",
"db_currency_id": "7ab387f0-4037-4969-abe2-cc64baafaf39",
"db_language_id": "ed7c8a8a-b1da-452d-8d5e-c9c8a0933e97",
"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-17T22:21:54.970024+00:00"
},
"modified_dateutc": "2025-11-17T22:21:54.970024+00:00"
},
"equipment_model_id": "8e0a4900-4274-4653-9912-4f811800f8e6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0f3fc87f-f721-4c80-89f3-4f9e1fcaebd7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "49a42c41-b661-454a-b1b8-19cf0f18c96f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "20f1b182-3887-456a-abab-d2d8594d910d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ea3d296f-d0cb-4b31-a7b5-05e3c280a106",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ccfec3b9-f859-44e4-b9d4-443850b0a8b0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "529320d0-1e4d-46c2-aaea-2cc236fe00f8",
"db_currency_id": "7ab387f0-4037-4969-abe2-cc64baafaf39",
"db_language_id": "ed7c8a8a-b1da-452d-8d5e-c9c8a0933e97",
"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-17T22:21:54.970024+00:00"
},
"modified_dateutc": "2025-11-17T22:21:54.970024+00:00"
},
"equipment_family_id": "7a2727b4-26b6-4ab2-a853-d49eb164cdea",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b3cb3799-8996-41c6-b4e8-b33c96cae8d8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "af550223-d192-4b74-ac7f-77fae168ace8",
"_parent_code": "sample string 6",
"sales_organization_id": "760fbe42-f041-4519-ad3b-984dc2ec01cc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ccfec3b9-f859-44e4-b9d4-443850b0a8b0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "529320d0-1e4d-46c2-aaea-2cc236fe00f8",
"db_currency_id": "7ab387f0-4037-4969-abe2-cc64baafaf39",
"db_language_id": "ed7c8a8a-b1da-452d-8d5e-c9c8a0933e97",
"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-17T22:21:54.970024+00:00"
},
"modified_dateutc": "2025-11-17T22:21:54.970024+00:00"
},
"date_in_production_since": "2025-11-17T22:21:54.970024+00:00",
"date_out_of_production_since": "2025-11-17T22:21:54.970024+00:00",
"date_end_support": "2025-11-17T22:21:54.970024+00:00",
"sales_organization_id": "ec7d008a-a7dc-4e43-b53b-5320ade1fbaa",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ccfec3b9-f859-44e4-b9d4-443850b0a8b0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "529320d0-1e4d-46c2-aaea-2cc236fe00f8",
"db_currency_id": "7ab387f0-4037-4969-abe2-cc64baafaf39",
"db_language_id": "ed7c8a8a-b1da-452d-8d5e-c9c8a0933e97",
"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-17T22:21:54.970024+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-17T22:21:54.970024+00:00"
},
"project_status_id": "028d03ab-2d71-466f-88ef-d334cbfed35b",
"project_status_code": "sample string 10",
"project_status": {
"id": "5c04f455-4cd0-4fe5-abb4-09360ce3a84d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b0477ced-604c-4c65-9335-4e2268136ade",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ccfec3b9-f859-44e4-b9d4-443850b0a8b0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "529320d0-1e4d-46c2-aaea-2cc236fe00f8",
"db_currency_id": "7ab387f0-4037-4969-abe2-cc64baafaf39",
"db_language_id": "ed7c8a8a-b1da-452d-8d5e-c9c8a0933e97",
"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-17T22:21:54.970024+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-17T22:21:54.970024+00:00"
},
"company_id": "a2750228-42f9-4978-92e3-92a21ea458ff",
"company_code": "sample string 12",
"db_address_id": "d6222653-89d2-42ad-ac8c-a1aa0803352e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f89e980c-a506-403e-a625-75d159c3820e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "08dad443-6987-4d80-866a-300d5f96414b",
"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-17T22:21:54.970024+00:00",
"date_create": "2025-11-17T22:21:54.970024+00:00",
"date_update": "2025-11-17T22:21:54.970024+00:00",
"updated_by_user_id": "f1f11087-bb67-4b53-bb86-00f6a8320570",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-17T22:21:54.970024+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-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-17T22:21:54.970024+00:00",
"date_last_job": "2025-11-17T22:21:54.970024+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-17T22:21:54.970024+00:00",
"modified_dateutc": "2025-11-17T22:21:54.970024+00:00",
"is_mobile_installation": true
},
"job_type_id": "de01db40-fa00-4b60-83be-30cbc37dcef0",
"job_type_code": "sample string 7",
"job_type": {
"id": "3dab80a1-71db-40d0-815d-3700d7d034c1",
"name": "sample string 2",
"sales_organization_id": "8ba32f84-6890-46fc-b150-2418c1bb466f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-17T22:21:54.970024+00:00",
"code": "sample string 7"
},
"job_priority_id": "090853e3-63c3-4a42-b707-03ab2a3972f3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b0295782-72d1-4cff-bee4-dd6441d08e95",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b3ee52b6-e103-4252-8036-df3c6a7e7ea2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ccfec3b9-f859-44e4-b9d4-443850b0a8b0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "529320d0-1e4d-46c2-aaea-2cc236fe00f8",
"db_currency_id": "7ab387f0-4037-4969-abe2-cc64baafaf39",
"db_language_id": "ed7c8a8a-b1da-452d-8d5e-c9c8a0933e97",
"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-17T22:21:54.970024+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-17T22:21:54.970024+00:00"
},
"job_status_id": "f4d865ba-96da-4d88-9838-3490229e59c6",
"job_status_code": "sample string 11",
"db_address_id": "8d459783-a791-4ac2-bc77-26bce8e6c1f3",
"contact_id": "b3365a0f-5f1c-4460-b3e8-de242c0500d8",
"requested_by_company_id": "a5beac40-404b-42f3-8cfc-d3953b6f42f9",
"requested_by_contact_id": "4917966f-2084-4027-b1ab-b406895646ee",
"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-17T22:21:54.970024+00:00",
"due_date": "2025-11-17T22:21:54.970024+00:00",
"date_create": "2025-11-17T22:21:54.970024+00:00",
"date_update": "2025-11-17T22:21:54.970024+00:00",
"date_closed": "2025-11-17T22:21:54.970024+00:00",
"suggested_user_id": "800641c1-d6c5-4493-892b-2bb91f14e735",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "238b83d3-a49a-4999-838b-8621a1789aff",
"db_language_id": "5f4b5f2d-cc54-4f6c-bc58-e4d61f65bf64",
"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-17T22:21:54.970024+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "062fb35a-5af5-479b-962c-668a64b2e072",
"sales_organization": {
"id": "ccfec3b9-f859-44e4-b9d4-443850b0a8b0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "529320d0-1e4d-46c2-aaea-2cc236fe00f8",
"db_currency_id": "7ab387f0-4037-4969-abe2-cc64baafaf39",
"db_language_id": "ed7c8a8a-b1da-452d-8d5e-c9c8a0933e97",
"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-17T22:21:54.970024+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "73ce2134-c950-4445-892b-534d5c70f256",
"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": "c294af5e-7455-4384-b4a9-11d4d8c86bde",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-17T22:21:54.970024+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "443ede0e-f2f2-4d89-bcf2-74069cc0d0d7"
},
"suggested_date_start": "2025-11-17T22:21:54.970024+00:00",
"skill_id": "86e683e0-56be-4b6a-8ba8-74f219036cf5",
"skill_code": "sample string 32",
"skill": {
"id": "5f17bae8-8a01-4860-8dfd-3c285d654889",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9b7406de-209b-4c9c-b7b5-ecff4ef9d3c9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ccfec3b9-f859-44e4-b9d4-443850b0a8b0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "529320d0-1e4d-46c2-aaea-2cc236fe00f8",
"db_currency_id": "7ab387f0-4037-4969-abe2-cc64baafaf39",
"db_language_id": "ed7c8a8a-b1da-452d-8d5e-c9c8a0933e97",
"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-17T22:21:54.970024+00:00"
},
"modified_dateutc": "2025-11-17T22:21:54.970024+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "440e556d-4f73-464e-85f0-9a2bb272cd62",
"date_reported_by_company": "2025-11-17T22:21:54.970024+00:00",
"id2": 36,
"company_id": "1f3a2920-bd20-46be-837a-ccd86c9143eb",
"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": "6f64b2e1-1df9-4017-b3e3-a1ccd9f2159d",
"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-17T22:21:54.970024+00:00"
},
"work_instruction_details_id": "f7772f01-ce77-4081-8326-79c69b898117",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3b2f391e-aa2e-4473-8c93-ffdc4aa29465",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f6482d69-ad73-409b-9ebe-6c67f034a6d2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-17T22:21:54.970024+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": "c6a198f6-58a0-418e-804a-1241eb136705",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-17T22:21:54.970024+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.