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": "b13cf2de-bad3-4777-b8c9-f05b265db2af",
"jobs_id": "96cddcbd-5632-4fe7-9e97-7dbdf1c503a4",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "cc6ed2ff-6ba6-411a-8ac6-623d5f9c17af",
"_parent_id": "9effccf2-71be-49c2-9fa9-52a07cd2c111",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5f3bdd41-0f32-4979-bb23-d7f8f11f7df5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e4a9f464-65ff-48ea-b013-a447e693c7c1",
"_parent_id": "acbd81cd-fd37-47f9-9bfa-6dd7233bf2b8",
"root_parent_id": "ab5e30fe-25a4-4e6f-89ae-0b6fca5c5990",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f1a9b8b2-937f-4fb7-b82f-aa5bfdc4c1a4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "978c28bc-6949-48a2-8524-bd2958e26d5a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "afc1303b-a8ed-4614-8912-ce7e0db13e20",
"_parent_code": "sample string 6",
"sales_organization_id": "07866075-e66b-435a-b0d8-c1566d563da8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9fc5be3a-9dbc-4311-ab32-730bf84e10ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04129b89-8c17-4eb5-8112-13eaf83331ac",
"db_currency_id": "9cba8cee-687e-444a-8019-72e985c21ca8",
"db_language_id": "60d087c5-c873-4654-b732-897bf6438fe1",
"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-01-26T09:15:48.6357072+00:00"
},
"modified_dateutc": "2026-01-26T09:15:48.6357072+00:00"
},
"equipment_model_id": "cd146b03-d182-4e4d-b785-3760eb07c931",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "172ffb7c-872b-411d-a64c-14d0e52dacac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c0581592-a654-497b-bef8-05ed016bc7c7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b315c8c7-8bf3-4e7c-9d58-bcabedf1fa8e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ab572cce-3e96-44a4-9e6e-a7fb3196e4d8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9fc5be3a-9dbc-4311-ab32-730bf84e10ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04129b89-8c17-4eb5-8112-13eaf83331ac",
"db_currency_id": "9cba8cee-687e-444a-8019-72e985c21ca8",
"db_language_id": "60d087c5-c873-4654-b732-897bf6438fe1",
"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-01-26T09:15:48.6357072+00:00"
},
"modified_dateutc": "2026-01-26T09:15:48.6357072+00:00"
},
"equipment_family_id": "17559ac3-c018-4efb-9a17-d1eac70a6c3f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "978c28bc-6949-48a2-8524-bd2958e26d5a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "afc1303b-a8ed-4614-8912-ce7e0db13e20",
"_parent_code": "sample string 6",
"sales_organization_id": "07866075-e66b-435a-b0d8-c1566d563da8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9fc5be3a-9dbc-4311-ab32-730bf84e10ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04129b89-8c17-4eb5-8112-13eaf83331ac",
"db_currency_id": "9cba8cee-687e-444a-8019-72e985c21ca8",
"db_language_id": "60d087c5-c873-4654-b732-897bf6438fe1",
"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-01-26T09:15:48.6357072+00:00"
},
"modified_dateutc": "2026-01-26T09:15:48.6357072+00:00"
},
"date_in_production_since": "2026-01-26T09:15:48.6357072+00:00",
"date_out_of_production_since": "2026-01-26T09:15:48.6357072+00:00",
"date_end_support": "2026-01-26T09:15:48.6357072+00:00",
"sales_organization_id": "2e43f627-7d94-48c5-bf86-23a48e6ffab8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9fc5be3a-9dbc-4311-ab32-730bf84e10ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04129b89-8c17-4eb5-8112-13eaf83331ac",
"db_currency_id": "9cba8cee-687e-444a-8019-72e985c21ca8",
"db_language_id": "60d087c5-c873-4654-b732-897bf6438fe1",
"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-01-26T09:15:48.6357072+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-01-26T09:15:48.6357072+00:00"
},
"project_status_id": "5a5b57c7-1dc3-4e02-96f5-0ea6adc7e0cf",
"project_status_code": "sample string 10",
"project_status": {
"id": "52bda5fd-6afd-4e77-993c-53635dbb5ac4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1df5ccb1-8dfa-4bc7-99e9-1a321950ce1c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9fc5be3a-9dbc-4311-ab32-730bf84e10ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04129b89-8c17-4eb5-8112-13eaf83331ac",
"db_currency_id": "9cba8cee-687e-444a-8019-72e985c21ca8",
"db_language_id": "60d087c5-c873-4654-b732-897bf6438fe1",
"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-01-26T09:15:48.6357072+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-26T09:15:48.6357072+00:00"
},
"company_id": "3fc15cae-68bc-4265-8da1-2d0461be47ec",
"company_code": "sample string 12",
"db_address_id": "f190ab4f-3628-4864-bccd-49984e5af60d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6040b099-22f1-47ac-a37a-2903d41f261f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e1391dc5-9fa8-49d2-a8b8-ffdaeffa51d1",
"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-01-26T09:15:48.6357072+00:00",
"date_create": "2026-01-26T09:15:48.6357072+00:00",
"date_update": "2026-01-26T09:15:48.6357072+00:00",
"updated_by_user_id": "776761e1-a304-47f3-9498-522d77a958ee",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-26T09:15:48.6357072+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-01-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-26T09:15:48.6357072+00:00",
"date_last_job": "2026-01-26T09:15:48.6357072+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-26T09:15:48.6357072+00:00",
"modified_dateutc": "2026-01-26T09:15:48.6357072+00:00",
"is_mobile_installation": true
},
"job_type_id": "73981190-3b3a-464f-a864-f216755fa5a1",
"job_type_code": "sample string 7",
"job_type": {
"id": "815b891e-02d0-4c32-b1fc-8669d415a392",
"name": "sample string 2",
"sales_organization_id": "4b725150-9506-4cd2-8159-c1faec35f023",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-26T09:15:48.6357072+00:00",
"code": "sample string 7"
},
"job_priority_id": "92cc5ced-8cd1-4f43-bcdc-8dcde3d8fe61",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9adf33ed-e632-490c-b67b-8e9f54f86f20",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c15c81ce-2b77-469d-86f4-41d142a442c4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9fc5be3a-9dbc-4311-ab32-730bf84e10ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04129b89-8c17-4eb5-8112-13eaf83331ac",
"db_currency_id": "9cba8cee-687e-444a-8019-72e985c21ca8",
"db_language_id": "60d087c5-c873-4654-b732-897bf6438fe1",
"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-01-26T09:15:48.6357072+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-26T09:15:48.6357072+00:00"
},
"job_status_id": "53cdc0ad-9983-4832-91f6-d5687e57bdfa",
"job_status_code": "sample string 11",
"db_address_id": "9a1918b1-1ea0-4ffe-96bb-a3efe2adb583",
"contact_id": "fafe9ca7-b9cf-4a33-ae77-6c0b14e8a142",
"requested_by_company_id": "4ca255ed-2ec5-4519-9d4e-a18bd1737ac8",
"requested_by_contact_id": "4f20fb71-2e44-4c27-a457-c4557f3ccf99",
"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-01-26T09:15:48.6357072+00:00",
"due_date": "2026-01-26T09:15:48.6357072+00:00",
"date_create": "2026-01-26T09:15:48.6357072+00:00",
"date_update": "2026-01-26T09:15:48.6357072+00:00",
"date_closed": "2026-01-26T09:15:48.6357072+00:00",
"suggested_user_id": "5eaa54ca-483c-495c-b55b-f9183cdde8b5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a1b752f2-e286-41e3-afff-ff0b63b9a4e1",
"db_language_id": "949f06d2-58e2-4ea5-99ce-ff540214fd64",
"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-01-26T09:15:48.651328+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "885e2bd8-62a2-4311-abb0-7660f62d862d",
"sales_organization": {
"id": "9fc5be3a-9dbc-4311-ab32-730bf84e10ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04129b89-8c17-4eb5-8112-13eaf83331ac",
"db_currency_id": "9cba8cee-687e-444a-8019-72e985c21ca8",
"db_language_id": "60d087c5-c873-4654-b732-897bf6438fe1",
"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-01-26T09:15:48.6357072+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e6caffed-0740-43d0-88a0-1785e47b90a3",
"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": "427771de-7c0c-42e1-a429-61aa9215091b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-26T09:15:48.651328+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c539e527-ed8f-414c-9da9-65c0dd7b29b4"
},
"suggested_date_start": "2026-01-26T09:15:48.651328+00:00",
"skill_id": "f34e0151-b37e-40b7-9b6f-4a8a85438c38",
"skill_code": "sample string 32",
"skill": {
"id": "6f2b305d-7e46-4d95-869b-847200b02499",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c7ba2e43-bd54-4d7f-9ad1-2a217ebbf181",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9fc5be3a-9dbc-4311-ab32-730bf84e10ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04129b89-8c17-4eb5-8112-13eaf83331ac",
"db_currency_id": "9cba8cee-687e-444a-8019-72e985c21ca8",
"db_language_id": "60d087c5-c873-4654-b732-897bf6438fe1",
"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-01-26T09:15:48.6357072+00:00"
},
"modified_dateutc": "2026-01-26T09:15:48.651328+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ec6372d5-727a-4add-8191-a3dc848ba5dd",
"date_reported_by_company": "2026-01-26T09:15:48.651328+00:00",
"id2": 36,
"company_id": "0031bcd3-c312-4f81-920b-b3703afe6361",
"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": "f0c5da6a-491a-43c0-9ef1-fd4f08a63e6f",
"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-01-26T09:15:48.651328+00:00"
},
"work_instruction_details_id": "5b0c8357-8b2f-47e1-8f39-f2ccee9775d0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "cca9f11d-d7c9-49ba-9c19-e7b280f655b7",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "182edfa4-5c8c-4550-9ee9-34f2c9212aaf",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-26T09:15:48.651328+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": "fa542a9d-5619-496c-9835-861e87cd6fb2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-26T09:15:48.651328+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.