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": "cdb29555-b649-4185-b710-e5aaffff3bea",
"jobs_id": "05c0ab7a-d9fc-4ac8-aad7-9c00b0d6622c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5bc167a3-5567-45c5-9584-b69edb798171",
"_parent_id": "26098182-21ca-4f32-a851-b11cbfc5a8ab",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1f170c2e-3358-4ba3-b746-e07a21a728aa",
"project_reference_back_office": "sample string 5",
"project": {
"id": "62d389a0-df61-48d4-8f22-51b182f896a7",
"_parent_id": "ec3c539f-a49e-488a-9c6d-33b215215588",
"root_parent_id": "16bd7a57-b9be-4fbc-8b44-4b3e66e9e9dd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "dec465ea-db6d-4f0e-b518-68acbb94b175",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c2a8d802-c5f2-47ef-a4f6-494e4c23ce9f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8d8d86b4-e233-4921-8cb5-897a9f890c5a",
"_parent_code": "sample string 6",
"sales_organization_id": "410d53c9-5bff-4282-bead-3fce4b9d6eac",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3dbb8ba3-b2ac-4f08-80f7-0e621e0e1bbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4e39138c-f3e3-419e-a23b-7d33cf05f287",
"db_currency_id": "65a74380-4ac0-46df-9a2c-02e753558702",
"db_language_id": "19170974-6f9e-489b-87ea-b4ae75c76c03",
"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-04-24T07:14:34.3642598+00:00"
},
"modified_dateutc": "2026-04-24T07:14:34.3642598+00:00"
},
"equipment_model_id": "453e246f-0572-430c-be2f-a8a647c4c535",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c8797288-ca9a-4219-9dbc-6b6d985ae0d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3b56840e-73d3-41cf-bcd1-84eb8337611a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "574ef206-cea6-42a8-80e1-5dfa4156a549",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b5fd69c7-8f54-42cc-ae3f-2c25652e7f56",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3dbb8ba3-b2ac-4f08-80f7-0e621e0e1bbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4e39138c-f3e3-419e-a23b-7d33cf05f287",
"db_currency_id": "65a74380-4ac0-46df-9a2c-02e753558702",
"db_language_id": "19170974-6f9e-489b-87ea-b4ae75c76c03",
"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-04-24T07:14:34.3642598+00:00"
},
"modified_dateutc": "2026-04-24T07:14:34.3798838+00:00"
},
"equipment_family_id": "ceefff3c-d876-4b2e-9b7e-d03aa5235955",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c2a8d802-c5f2-47ef-a4f6-494e4c23ce9f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8d8d86b4-e233-4921-8cb5-897a9f890c5a",
"_parent_code": "sample string 6",
"sales_organization_id": "410d53c9-5bff-4282-bead-3fce4b9d6eac",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3dbb8ba3-b2ac-4f08-80f7-0e621e0e1bbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4e39138c-f3e3-419e-a23b-7d33cf05f287",
"db_currency_id": "65a74380-4ac0-46df-9a2c-02e753558702",
"db_language_id": "19170974-6f9e-489b-87ea-b4ae75c76c03",
"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-04-24T07:14:34.3642598+00:00"
},
"modified_dateutc": "2026-04-24T07:14:34.3642598+00:00"
},
"date_in_production_since": "2026-04-24T07:14:34.3798838+00:00",
"date_out_of_production_since": "2026-04-24T07:14:34.3798838+00:00",
"date_end_support": "2026-04-24T07:14:34.3798838+00:00",
"sales_organization_id": "5600eeea-18bc-40b6-b920-bfb618ddb07d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3dbb8ba3-b2ac-4f08-80f7-0e621e0e1bbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4e39138c-f3e3-419e-a23b-7d33cf05f287",
"db_currency_id": "65a74380-4ac0-46df-9a2c-02e753558702",
"db_language_id": "19170974-6f9e-489b-87ea-b4ae75c76c03",
"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-04-24T07:14:34.3642598+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-04-24T07:14:34.3798838+00:00"
},
"project_status_id": "46b0ee51-8fab-440c-b782-7def8106c912",
"project_status_code": "sample string 10",
"project_status": {
"id": "f9abd13d-52ff-41a5-9680-2e830f90830e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7b98af04-0ca3-41f6-93a9-d524a57a1ac5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3dbb8ba3-b2ac-4f08-80f7-0e621e0e1bbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4e39138c-f3e3-419e-a23b-7d33cf05f287",
"db_currency_id": "65a74380-4ac0-46df-9a2c-02e753558702",
"db_language_id": "19170974-6f9e-489b-87ea-b4ae75c76c03",
"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-04-24T07:14:34.3642598+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-24T07:14:34.3798838+00:00"
},
"company_id": "3a531812-fea7-4d34-b0e6-a02fa1e49e3e",
"company_code": "sample string 12",
"db_address_id": "7111e833-1042-468e-888e-72f8d936b38e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b2a4c765-9c7c-4d77-a9ba-4958a4b588f6",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "19bc0b67-e72e-4e41-871b-77f1bf7bcea0",
"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-04-24T07:14:34.3798838+00:00",
"date_create": "2026-04-24T07:14:34.3798838+00:00",
"date_update": "2026-04-24T07:14:34.3798838+00:00",
"updated_by_user_id": "c6acb644-7dd6-4927-b451-0c7e7d37fef5",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-24T07:14:34.3798838+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-04-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-24T07:14:34.3798838+00:00",
"date_last_job": "2026-04-24T07:14:34.3798838+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-24T07:14:34.3798838+00:00",
"modified_dateutc": "2026-04-24T07:14:34.3798838+00:00",
"is_mobile_installation": true
},
"job_type_id": "e9d5329f-387d-4f11-b5ab-582a5b5fabdc",
"job_type_code": "sample string 7",
"job_type": {
"id": "f89aec7b-7bb4-4e23-984f-8a1a5740920d",
"name": "sample string 2",
"sales_organization_id": "11606830-51a1-4480-82c7-e61c325e1928",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-24T07:14:34.3798838+00:00",
"code": "sample string 7"
},
"job_priority_id": "96ff51c9-d52b-43bb-a524-411344b9c035",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a1d83957-6f9c-4b3c-a3f0-e906e6b6b3af",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f97def1e-e54b-46bd-acf2-dacac02d7e55",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3dbb8ba3-b2ac-4f08-80f7-0e621e0e1bbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4e39138c-f3e3-419e-a23b-7d33cf05f287",
"db_currency_id": "65a74380-4ac0-46df-9a2c-02e753558702",
"db_language_id": "19170974-6f9e-489b-87ea-b4ae75c76c03",
"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-04-24T07:14:34.3642598+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-24T07:14:34.3798838+00:00"
},
"job_status_id": "c771f762-56a6-4a40-8c7c-04a2f276e9bf",
"job_status_code": "sample string 11",
"db_address_id": "220c51a8-df84-4b47-b3f4-95ee4088ffcd",
"contact_id": "b46c04db-fb36-48b8-b938-4df5529ddb9d",
"requested_by_company_id": "02dc6f07-7157-43e7-8792-44da99d98ac8",
"requested_by_contact_id": "7f815665-f7b7-41e6-abd7-2214f44bb58d",
"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-04-24T07:14:34.3798838+00:00",
"due_date": "2026-04-24T07:14:34.3798838+00:00",
"date_create": "2026-04-24T07:14:34.3798838+00:00",
"date_update": "2026-04-24T07:14:34.3798838+00:00",
"date_closed": "2026-04-24T07:14:34.3798838+00:00",
"suggested_user_id": "ba90d352-d636-4d19-8b03-99f117a9c4e4",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8ab7c921-b868-466e-bee0-2dfc15e09673",
"db_language_id": "eef0c2e9-3334-4cf4-880e-56ff76470caa",
"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-04-24T07:14:34.3798838+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7522174b-df6d-4ce9-a323-6c0e21e45e0d",
"sales_organization": {
"id": "3dbb8ba3-b2ac-4f08-80f7-0e621e0e1bbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4e39138c-f3e3-419e-a23b-7d33cf05f287",
"db_currency_id": "65a74380-4ac0-46df-9a2c-02e753558702",
"db_language_id": "19170974-6f9e-489b-87ea-b4ae75c76c03",
"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-04-24T07:14:34.3642598+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e7ed9db1-6315-4c91-877e-a7b3f80c7495",
"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": "1c461ef2-2bd7-40b1-be0e-56528b2122b8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-24T07:14:34.3798838+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7ac32aaa-172c-4bbd-ab26-6d3c5339a6aa"
},
"suggested_date_start": "2026-04-24T07:14:34.3798838+00:00",
"skill_id": "aaaaa0d5-5da0-4ea5-a1f6-1f242141ab9a",
"skill_code": "sample string 32",
"skill": {
"id": "fa91e796-cb83-4918-a2c4-eb4e007e47a2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d2ac3276-1bc4-4a6a-9b78-1e8e1ca0359e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3dbb8ba3-b2ac-4f08-80f7-0e621e0e1bbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4e39138c-f3e3-419e-a23b-7d33cf05f287",
"db_currency_id": "65a74380-4ac0-46df-9a2c-02e753558702",
"db_language_id": "19170974-6f9e-489b-87ea-b4ae75c76c03",
"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-04-24T07:14:34.3642598+00:00"
},
"modified_dateutc": "2026-04-24T07:14:34.3798838+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c318de99-096d-406c-83e2-d62014c301e9",
"date_reported_by_company": "2026-04-24T07:14:34.3798838+00:00",
"id2": 36,
"company_id": "129105f8-ec26-4bb1-9b86-02a289539b35",
"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": "5ed5b3a7-da2b-42f5-846d-e1279a9dc1f5",
"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-04-24T07:14:34.3798838+00:00"
},
"work_instruction_details_id": "71f0302e-aabd-45eb-88f5-7d6d5bec972f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "53c18fc1-bbc0-46bc-b6d5-da9252861fdc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5d07511c-61d7-4fed-b853-6463d097ad73",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-24T07:14:34.3798838+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": "e3a1da2f-2316-4579-94ff-4070b3240a9e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-24T07:14:34.3798838+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.