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": "11d19df6-d077-4100-baf8-54879f155d3c",
"jobs_id": "00900637-54e1-4af4-88f3-372431ba028b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c9175d5a-55f7-4dd4-9e36-cea6a4807828",
"_parent_id": "d0da606d-34b2-4929-8604-b64eaaaf2329",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c801a8d7-3bc6-406c-a01d-282457561ab5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f3955480-e5ff-4a2e-99dd-8455e35e55e8",
"_parent_id": "ce29969b-8126-41d3-b35d-d7961aac157a",
"root_parent_id": "967628df-72b6-4842-bec9-8a5c36032225",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "da307f24-9d82-4f76-8599-0bd56fa73702",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a3b04233-ce0f-4210-99b3-3b773831fba6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "eb5f8cb7-78a8-49bf-b886-235aa6e76b1b",
"_parent_code": "sample string 6",
"sales_organization_id": "521dad2f-7662-457a-9670-3ea2a90f8134",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2893faab-c6c9-4dd3-a70b-b038c1535734",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d837fba-8347-4418-a931-ef5d1b8ff780",
"db_currency_id": "3aea1bb6-d414-4b0d-845f-475c0dc4c053",
"db_language_id": "e987bdbd-949c-4c3c-997a-c18be1f9b83f",
"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-29T03:47:27.681029+00:00"
},
"modified_dateutc": "2025-11-29T03:47:27.681029+00:00"
},
"equipment_model_id": "45b9d9d3-b3e3-48ff-891e-218a9f325a7d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "dc4a7c53-050a-4509-a2f3-b8988130e4c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9575d7e6-9fd3-402a-bf1f-33e1ca396479",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "890a693e-614f-41ee-8617-e660cb5af1dd",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f26e2568-f4ab-460e-8b8b-62606f50b506",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2893faab-c6c9-4dd3-a70b-b038c1535734",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d837fba-8347-4418-a931-ef5d1b8ff780",
"db_currency_id": "3aea1bb6-d414-4b0d-845f-475c0dc4c053",
"db_language_id": "e987bdbd-949c-4c3c-997a-c18be1f9b83f",
"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-29T03:47:27.681029+00:00"
},
"modified_dateutc": "2025-11-29T03:47:27.681029+00:00"
},
"equipment_family_id": "9e22bac5-7dc6-473a-9cf9-79afcea975a2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a3b04233-ce0f-4210-99b3-3b773831fba6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "eb5f8cb7-78a8-49bf-b886-235aa6e76b1b",
"_parent_code": "sample string 6",
"sales_organization_id": "521dad2f-7662-457a-9670-3ea2a90f8134",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2893faab-c6c9-4dd3-a70b-b038c1535734",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d837fba-8347-4418-a931-ef5d1b8ff780",
"db_currency_id": "3aea1bb6-d414-4b0d-845f-475c0dc4c053",
"db_language_id": "e987bdbd-949c-4c3c-997a-c18be1f9b83f",
"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-29T03:47:27.681029+00:00"
},
"modified_dateutc": "2025-11-29T03:47:27.681029+00:00"
},
"date_in_production_since": "2025-11-29T03:47:27.681029+00:00",
"date_out_of_production_since": "2025-11-29T03:47:27.681029+00:00",
"date_end_support": "2025-11-29T03:47:27.681029+00:00",
"sales_organization_id": "71093b9b-5bb5-4fe1-9296-75b629e6e916",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2893faab-c6c9-4dd3-a70b-b038c1535734",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d837fba-8347-4418-a931-ef5d1b8ff780",
"db_currency_id": "3aea1bb6-d414-4b0d-845f-475c0dc4c053",
"db_language_id": "e987bdbd-949c-4c3c-997a-c18be1f9b83f",
"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-29T03:47:27.681029+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-29T03:47:27.681029+00:00"
},
"project_status_id": "26bcb8fb-0b0f-4da8-bddd-a8468adeffc7",
"project_status_code": "sample string 10",
"project_status": {
"id": "4c6c9f11-eeb3-4b5a-b4d2-0645ecbdecd7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c9b9855c-00ff-4522-b8a8-102d499da41a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2893faab-c6c9-4dd3-a70b-b038c1535734",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d837fba-8347-4418-a931-ef5d1b8ff780",
"db_currency_id": "3aea1bb6-d414-4b0d-845f-475c0dc4c053",
"db_language_id": "e987bdbd-949c-4c3c-997a-c18be1f9b83f",
"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-29T03:47:27.681029+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-29T03:47:27.681029+00:00"
},
"company_id": "03d71802-3641-4466-a20a-ba6b917a21a5",
"company_code": "sample string 12",
"db_address_id": "7092c61c-e8ba-4630-9b64-a105586862f2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a62c81de-c91f-439c-94b5-3d421bc26465",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c7c7c16d-254e-4392-8e6d-c4ff9d218e2e",
"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-29T03:47:27.681029+00:00",
"date_create": "2025-11-29T03:47:27.681029+00:00",
"date_update": "2025-11-29T03:47:27.681029+00:00",
"updated_by_user_id": "ac6a633f-2bb3-4e3a-a226-50f5cb32ea47",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-29T03:47:27.681029+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-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-29T03:47:27.681029+00:00",
"date_last_job": "2025-11-29T03:47:27.681029+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-29T03:47:27.681029+00:00",
"modified_dateutc": "2025-11-29T03:47:27.681029+00:00",
"is_mobile_installation": true
},
"job_type_id": "e93ceb2c-edd8-4b67-bda2-3c6a268fb859",
"job_type_code": "sample string 7",
"job_type": {
"id": "0cdac849-e918-4898-82ad-5c43c4c7420b",
"name": "sample string 2",
"sales_organization_id": "ed7ccbf4-d186-42c8-ae91-d8f35a4ca99c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-29T03:47:27.681029+00:00",
"code": "sample string 7"
},
"job_priority_id": "3345af7d-0440-45d2-95bb-2a5003838a52",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c55fd3fb-cec7-48c7-af53-4ecdc4b553a8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8f67a166-9d1f-4792-a1ed-7dc043f126ed",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2893faab-c6c9-4dd3-a70b-b038c1535734",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d837fba-8347-4418-a931-ef5d1b8ff780",
"db_currency_id": "3aea1bb6-d414-4b0d-845f-475c0dc4c053",
"db_language_id": "e987bdbd-949c-4c3c-997a-c18be1f9b83f",
"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-29T03:47:27.681029+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-29T03:47:27.681029+00:00"
},
"job_status_id": "38f8b0fa-7084-42a3-9285-74d8698522b2",
"job_status_code": "sample string 11",
"db_address_id": "dc9b662b-a855-49f2-ba92-4edf8939d1ba",
"contact_id": "4453fd3d-5141-4a46-b2a0-3d29ecfec9a1",
"requested_by_company_id": "e0fd6eac-adaf-42d6-84a0-cc43d48885ca",
"requested_by_contact_id": "5257274b-8291-4e7a-9659-aa98a45f9d29",
"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-29T03:47:27.681029+00:00",
"due_date": "2025-11-29T03:47:27.681029+00:00",
"date_create": "2025-11-29T03:47:27.681029+00:00",
"date_update": "2025-11-29T03:47:27.681029+00:00",
"date_closed": "2025-11-29T03:47:27.681029+00:00",
"suggested_user_id": "b098a1ac-17e6-4ac6-8b44-0db06348d24b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a10ca2ab-265c-41b5-ba2b-0457d760911f",
"db_language_id": "69ac2f56-3131-4d76-a3cc-fc3d02f1601d",
"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-29T03:47:27.681029+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "095171cd-0772-4782-b68c-3934ef683ee4",
"sales_organization": {
"id": "2893faab-c6c9-4dd3-a70b-b038c1535734",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d837fba-8347-4418-a931-ef5d1b8ff780",
"db_currency_id": "3aea1bb6-d414-4b0d-845f-475c0dc4c053",
"db_language_id": "e987bdbd-949c-4c3c-997a-c18be1f9b83f",
"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-29T03:47:27.681029+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "70a53a6e-2d14-4521-b002-65c9978feae7",
"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": "29b452a2-9b20-4f5b-90f1-da89a6feea82",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-29T03:47:27.681029+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "fbe77699-d625-47ce-8980-bc1eb6cef24c"
},
"suggested_date_start": "2025-11-29T03:47:27.681029+00:00",
"skill_id": "31095b8a-e07b-4c6d-8f8d-ff4f356bf1c9",
"skill_code": "sample string 32",
"skill": {
"id": "d34338d9-04b0-4a82-bc22-cb8e94ab6527",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "79c8d39e-d75f-4fb9-96f3-b530a71aa987",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2893faab-c6c9-4dd3-a70b-b038c1535734",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d837fba-8347-4418-a931-ef5d1b8ff780",
"db_currency_id": "3aea1bb6-d414-4b0d-845f-475c0dc4c053",
"db_language_id": "e987bdbd-949c-4c3c-997a-c18be1f9b83f",
"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-29T03:47:27.681029+00:00"
},
"modified_dateutc": "2025-11-29T03:47:27.681029+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2329c5e3-6195-4c32-a4cf-41b7eb2db946",
"date_reported_by_company": "2025-11-29T03:47:27.681029+00:00",
"id2": 36,
"company_id": "70260a40-5ecb-4744-a435-7da7a07f42bb",
"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": "fcd831cb-937e-4e79-a285-a43db2ce2295",
"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-29T03:47:27.681029+00:00"
},
"work_instruction_details_id": "61de539a-8569-42cf-97ac-8ae20741f1c1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "31a13cad-4dcf-49e7-9423-b026afde8d01",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "af7a47e5-1c55-4340-81ac-87168c61a130",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-29T03:47:27.681029+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": "e4ed3727-ae11-43b8-b852-798ab682d7c0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-29T03:47:27.681029+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.