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": "3dbda7c0-e42d-4cec-a050-de1175ba7a23",
"jobs_id": "98a17721-adb3-4e46-935b-eab2739a67ef",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "df2d76b4-0fe2-4ada-8901-73318c4c53ff",
"_parent_id": "1d3d5f7e-7501-4f43-859a-61781078a30e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "18b59eed-a2f4-41da-b500-bddaba31a028",
"project_reference_back_office": "sample string 5",
"project": {
"id": "72c7e076-e67d-4eb3-a824-6a566c07e2a2",
"_parent_id": "9c8af3ce-26c6-466a-9082-75df2001f1ff",
"root_parent_id": "f8153d32-13e0-436c-8296-471a6bf8060c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "656196a2-f326-43e5-a983-e1668e2e8474",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a7146a0f-33e2-49fe-9367-3c12c8b5445d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bb620322-79e0-4cf8-a988-b96374f6bf6a",
"_parent_code": "sample string 6",
"sales_organization_id": "79444447-6090-47d8-a094-a7cf43fb824b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "33a615d0-cb78-424e-a265-4a2ab5e65a61",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f59d1377-ab7f-43b6-9043-71ee88fc97e7",
"db_currency_id": "5cee5667-7cc4-4f22-9f23-57d6c1a0e5dc",
"db_language_id": "0f3afa16-0416-4f57-a735-491fb83f30cf",
"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-12-06T03:18:10.694438+00:00"
},
"modified_dateutc": "2025-12-06T03:18:10.694438+00:00"
},
"equipment_model_id": "03997a96-337a-4ff8-85bf-dc0fd104abbc",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6c1123df-a54b-4370-8fbb-dba806d22e12",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9b6905fe-a977-47dd-ae85-ea277a034ffc",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c90bce70-a3d0-43a1-b0f7-2dd7c5ff4cf4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0c9dce44-58a1-4a5f-962d-519750e4da0b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "33a615d0-cb78-424e-a265-4a2ab5e65a61",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f59d1377-ab7f-43b6-9043-71ee88fc97e7",
"db_currency_id": "5cee5667-7cc4-4f22-9f23-57d6c1a0e5dc",
"db_language_id": "0f3afa16-0416-4f57-a735-491fb83f30cf",
"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-12-06T03:18:10.694438+00:00"
},
"modified_dateutc": "2025-12-06T03:18:10.694438+00:00"
},
"equipment_family_id": "ad2ffd73-abb6-47ea-950c-234f65229433",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a7146a0f-33e2-49fe-9367-3c12c8b5445d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bb620322-79e0-4cf8-a988-b96374f6bf6a",
"_parent_code": "sample string 6",
"sales_organization_id": "79444447-6090-47d8-a094-a7cf43fb824b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "33a615d0-cb78-424e-a265-4a2ab5e65a61",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f59d1377-ab7f-43b6-9043-71ee88fc97e7",
"db_currency_id": "5cee5667-7cc4-4f22-9f23-57d6c1a0e5dc",
"db_language_id": "0f3afa16-0416-4f57-a735-491fb83f30cf",
"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-12-06T03:18:10.694438+00:00"
},
"modified_dateutc": "2025-12-06T03:18:10.694438+00:00"
},
"date_in_production_since": "2025-12-06T03:18:10.694438+00:00",
"date_out_of_production_since": "2025-12-06T03:18:10.694438+00:00",
"date_end_support": "2025-12-06T03:18:10.694438+00:00",
"sales_organization_id": "c125e019-5f04-497f-b07c-f34cca882c51",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "33a615d0-cb78-424e-a265-4a2ab5e65a61",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f59d1377-ab7f-43b6-9043-71ee88fc97e7",
"db_currency_id": "5cee5667-7cc4-4f22-9f23-57d6c1a0e5dc",
"db_language_id": "0f3afa16-0416-4f57-a735-491fb83f30cf",
"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-12-06T03:18:10.694438+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-12-06T03:18:10.694438+00:00"
},
"project_status_id": "62f717f4-ff26-4f99-94de-149db1ee8c02",
"project_status_code": "sample string 10",
"project_status": {
"id": "3b4c9657-4908-486e-a01c-6455facac10d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5fb3805e-b77b-482f-b7c1-399753d33080",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "33a615d0-cb78-424e-a265-4a2ab5e65a61",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f59d1377-ab7f-43b6-9043-71ee88fc97e7",
"db_currency_id": "5cee5667-7cc4-4f22-9f23-57d6c1a0e5dc",
"db_language_id": "0f3afa16-0416-4f57-a735-491fb83f30cf",
"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-12-06T03:18:10.694438+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-06T03:18:10.694438+00:00"
},
"company_id": "a1616f62-5289-4df2-b94c-9fc1eff5ce7b",
"company_code": "sample string 12",
"db_address_id": "0949e7eb-4919-483a-8b16-924183b646fd",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3ce81eb5-b0ef-42bb-a06a-5f9f16ead6d1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d80ad8e7-ce10-4ff9-ab25-df59ce86c34a",
"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-12-06T03:18:10.694438+00:00",
"date_create": "2025-12-06T03:18:10.694438+00:00",
"date_update": "2025-12-06T03:18:10.694438+00:00",
"updated_by_user_id": "173b8621-ef23-4516-b7b6-134359112edd",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-06T03:18:10.694438+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-12-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-06T03:18:10.694438+00:00",
"date_last_job": "2025-12-06T03:18:10.694438+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-06T03:18:10.694438+00:00",
"modified_dateutc": "2025-12-06T03:18:10.694438+00:00",
"is_mobile_installation": true
},
"job_type_id": "020e82d1-5d6d-4ef5-8add-6523e8307df2",
"job_type_code": "sample string 7",
"job_type": {
"id": "11546cc0-845e-4732-a2c9-85ae0e6106a2",
"name": "sample string 2",
"sales_organization_id": "4c1b3e31-f672-4616-b59f-e024dc349638",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-06T03:18:10.694438+00:00",
"code": "sample string 7"
},
"job_priority_id": "631f73a2-1619-48ca-b45c-e322afd81cb0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3f09b97b-e0e8-48f6-8260-a70d2a9fc2fc",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "efd52102-28bf-49e6-aa58-456b8f39fb50",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "33a615d0-cb78-424e-a265-4a2ab5e65a61",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f59d1377-ab7f-43b6-9043-71ee88fc97e7",
"db_currency_id": "5cee5667-7cc4-4f22-9f23-57d6c1a0e5dc",
"db_language_id": "0f3afa16-0416-4f57-a735-491fb83f30cf",
"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-12-06T03:18:10.694438+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-06T03:18:10.694438+00:00"
},
"job_status_id": "77e0910e-4602-45ae-a206-29e9ae36e42a",
"job_status_code": "sample string 11",
"db_address_id": "0348c761-2146-4a57-b47b-7368869e0634",
"contact_id": "e0137eb9-0c37-42fc-af7a-2b5a0969c471",
"requested_by_company_id": "11e13268-840c-490e-913f-efb15c4c8c44",
"requested_by_contact_id": "9fcd3b2f-8105-4218-8d5e-7c351a95fba0",
"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-12-06T03:18:10.694438+00:00",
"due_date": "2025-12-06T03:18:10.694438+00:00",
"date_create": "2025-12-06T03:18:10.694438+00:00",
"date_update": "2025-12-06T03:18:10.694438+00:00",
"date_closed": "2025-12-06T03:18:10.694438+00:00",
"suggested_user_id": "4df19685-879b-428f-9433-f75567d52a44",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d97733bc-2a07-43b3-8c08-726e45fe4210",
"db_language_id": "9a0b551c-d871-4a85-85fd-3e9e9916670e",
"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-12-06T03:18:10.694438+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5e31c5dd-7aa2-4d63-8f8a-87abad2b867d",
"sales_organization": {
"id": "33a615d0-cb78-424e-a265-4a2ab5e65a61",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f59d1377-ab7f-43b6-9043-71ee88fc97e7",
"db_currency_id": "5cee5667-7cc4-4f22-9f23-57d6c1a0e5dc",
"db_language_id": "0f3afa16-0416-4f57-a735-491fb83f30cf",
"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-12-06T03:18:10.694438+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9408ea81-ce2c-492e-a229-ff582939c4cb",
"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": "cdc1a1e6-4e30-44ac-8b64-d406dc21b1d1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-06T03:18:10.694438+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "efb74916-3822-4670-80d7-26edb59d3b10"
},
"suggested_date_start": "2025-12-06T03:18:10.694438+00:00",
"skill_id": "de92c5ff-da58-4253-b52a-ae03dd4a3b79",
"skill_code": "sample string 32",
"skill": {
"id": "9a1a02f3-f797-416e-a17f-92a9af3ac1fb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0431d0e5-4cf0-4617-b18d-5b5883d84395",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "33a615d0-cb78-424e-a265-4a2ab5e65a61",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f59d1377-ab7f-43b6-9043-71ee88fc97e7",
"db_currency_id": "5cee5667-7cc4-4f22-9f23-57d6c1a0e5dc",
"db_language_id": "0f3afa16-0416-4f57-a735-491fb83f30cf",
"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-12-06T03:18:10.694438+00:00"
},
"modified_dateutc": "2025-12-06T03:18:10.694438+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d16cddd8-5155-4177-ab40-44857dc294f2",
"date_reported_by_company": "2025-12-06T03:18:10.694438+00:00",
"id2": 36,
"company_id": "8eb4a0d1-db49-491a-951a-f4cc926c13d5",
"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": "2f99516d-cf43-41a0-9793-0ce47eaf52f5",
"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-12-06T03:18:10.694438+00:00"
},
"work_instruction_details_id": "e55cca00-f87e-4d2f-a3b3-35296d10cd63",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7e7fcf11-0d73-4283-8bfa-0724f383f660",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "995281af-98f6-4b0d-a9dd-25dcf69d8d31",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-06T03:18:10.694438+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": "4f040195-6e99-4598-83e4-48ca31c2acf5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-06T03:18:10.694438+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.