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": "1f47e0f0-34d6-43d6-ba0c-0ea6f97611a8",
"jobs_id": "228eaee4-78f0-4d34-862e-ed4c5286bd89",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "28e5dd89-c240-483f-a90a-6dfe107966be",
"_parent_id": "3c00243c-be0a-4047-a2ba-2ab6e2f278a7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b4f7a869-b932-486f-ad33-4cc15ab86015",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c45a20fb-01c2-4380-b0ef-9a5a694a793f",
"_parent_id": "74e44cb0-6b68-4a23-906f-518ea457efa1",
"root_parent_id": "77a59f7e-c4c2-4e93-a298-cb5e6df4aae8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b41de5a2-ffa6-4237-bd1e-2878b3c32028",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "221758d5-d1d6-481b-84bf-31a53763c7f2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "61b7920c-1397-4f1f-a05f-971cb78c72e5",
"_parent_code": "sample string 6",
"sales_organization_id": "652cc3ff-5187-417b-a1c5-e33d2acb6495",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a7b878cc-5311-4769-be6b-a4c4e13c2dad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c269b1f0-df90-4484-a729-1150eef4a6b7",
"db_currency_id": "2327480b-4d7f-4572-b9e4-e9c3fd7bca06",
"db_language_id": "baae15ca-2c4a-4288-a52b-acde78b5b31f",
"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-06-18T14:43:13.1082108+00:00"
},
"modified_dateutc": "2026-06-18T14:43:13.1082108+00:00"
},
"equipment_model_id": "2c725f47-90e8-46da-8758-e70b607da6ed",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "bc20b244-98ca-4b8a-8fea-5d740e1b0ef5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5ec0c33d-3169-4c5a-89af-870e2e63c2aa",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "08d23b3f-1561-4737-905c-aedb6553e7d3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1ca6b234-d811-44d7-9bff-21f67d9eca6f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a7b878cc-5311-4769-be6b-a4c4e13c2dad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c269b1f0-df90-4484-a729-1150eef4a6b7",
"db_currency_id": "2327480b-4d7f-4572-b9e4-e9c3fd7bca06",
"db_language_id": "baae15ca-2c4a-4288-a52b-acde78b5b31f",
"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-06-18T14:43:13.1082108+00:00"
},
"modified_dateutc": "2026-06-18T14:43:13.1082108+00:00"
},
"equipment_family_id": "c94b1b9c-23e7-4dbb-add4-650aba6e53dc",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "221758d5-d1d6-481b-84bf-31a53763c7f2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "61b7920c-1397-4f1f-a05f-971cb78c72e5",
"_parent_code": "sample string 6",
"sales_organization_id": "652cc3ff-5187-417b-a1c5-e33d2acb6495",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a7b878cc-5311-4769-be6b-a4c4e13c2dad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c269b1f0-df90-4484-a729-1150eef4a6b7",
"db_currency_id": "2327480b-4d7f-4572-b9e4-e9c3fd7bca06",
"db_language_id": "baae15ca-2c4a-4288-a52b-acde78b5b31f",
"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-06-18T14:43:13.1082108+00:00"
},
"modified_dateutc": "2026-06-18T14:43:13.1082108+00:00"
},
"date_in_production_since": "2026-06-18T14:43:13.1082108+00:00",
"date_out_of_production_since": "2026-06-18T14:43:13.1082108+00:00",
"date_end_support": "2026-06-18T14:43:13.1082108+00:00",
"sales_organization_id": "afad77c2-056d-45e1-9a05-5c4f153bfa57",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a7b878cc-5311-4769-be6b-a4c4e13c2dad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c269b1f0-df90-4484-a729-1150eef4a6b7",
"db_currency_id": "2327480b-4d7f-4572-b9e4-e9c3fd7bca06",
"db_language_id": "baae15ca-2c4a-4288-a52b-acde78b5b31f",
"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-06-18T14:43:13.1082108+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-06-18T14:43:13.1082108+00:00"
},
"project_status_id": "a529d4d2-67b0-439b-9bbb-3f44a256b151",
"project_status_code": "sample string 10",
"project_status": {
"id": "69614fdd-0808-43df-b53d-c73e5534fdd0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8a08a5a6-70b4-4bec-a8f6-10024eca513d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a7b878cc-5311-4769-be6b-a4c4e13c2dad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c269b1f0-df90-4484-a729-1150eef4a6b7",
"db_currency_id": "2327480b-4d7f-4572-b9e4-e9c3fd7bca06",
"db_language_id": "baae15ca-2c4a-4288-a52b-acde78b5b31f",
"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-06-18T14:43:13.1082108+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-18T14:43:13.1082108+00:00"
},
"company_id": "f8c2efaf-67bc-45b9-9f9b-744229739e0c",
"company_code": "sample string 12",
"db_address_id": "93f2e2f9-60c3-4de6-8b7e-54ff3e866725",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "50c581e7-8775-4193-a6b5-ae1fccc2c6f6",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e6925ee1-7fc4-48b3-b9dd-7a27b70a073b",
"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-06-18T14:43:13.1082108+00:00",
"date_create": "2026-06-18T14:43:13.1082108+00:00",
"date_update": "2026-06-18T14:43:13.1082108+00:00",
"updated_by_user_id": "c8a0e883-25c1-4fd2-ada8-75d35e662342",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-18T14:43:13.1082108+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-06-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-18T14:43:13.1082108+00:00",
"date_last_job": "2026-06-18T14:43:13.1082108+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-18T14:43:13.1082108+00:00",
"modified_dateutc": "2026-06-18T14:43:13.1082108+00:00",
"is_mobile_installation": true
},
"job_type_id": "3cb7ee16-6299-44df-b1b4-555d626f580a",
"job_type_code": "sample string 7",
"job_type": {
"id": "94e95598-b195-4be1-8f7d-fd515d7aa7a3",
"name": "sample string 2",
"sales_organization_id": "eee1744a-4f35-4506-ad44-388471413228",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-18T14:43:13.1082108+00:00",
"code": "sample string 7"
},
"job_priority_id": "2bae257c-2ae7-44c1-a864-49864d1db8f0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "086b3645-2eb2-45cc-95f4-02291092a5c6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "50c8d1b6-d709-4137-8cc4-222e8f9f6db0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a7b878cc-5311-4769-be6b-a4c4e13c2dad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c269b1f0-df90-4484-a729-1150eef4a6b7",
"db_currency_id": "2327480b-4d7f-4572-b9e4-e9c3fd7bca06",
"db_language_id": "baae15ca-2c4a-4288-a52b-acde78b5b31f",
"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-06-18T14:43:13.1082108+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-18T14:43:13.1082108+00:00"
},
"job_status_id": "27fd2072-a7b0-4979-8a32-a34752bd314f",
"job_status_code": "sample string 11",
"db_address_id": "0b981333-f2ac-431e-a2bc-605abd8ba004",
"contact_id": "77249788-3294-4087-a339-2334358026c9",
"requested_by_company_id": "b138b6e3-7ccc-4da5-b845-14016d959840",
"requested_by_contact_id": "c6a6e957-6ed5-4c14-b14f-3dd3dc97d9f7",
"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-06-18T14:43:13.1082108+00:00",
"due_date": "2026-06-18T14:43:13.1082108+00:00",
"date_create": "2026-06-18T14:43:13.1082108+00:00",
"date_update": "2026-06-18T14:43:13.1082108+00:00",
"date_closed": "2026-06-18T14:43:13.1082108+00:00",
"suggested_user_id": "15df9632-34e4-404e-9e2d-89a91b05906d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2ab2eef5-8222-4643-95e4-ec998f57c51c",
"db_language_id": "5c420a58-31c1-41c2-9c33-012a344662cc",
"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-06-18T14:43:13.1082108+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "92ee686c-ba37-4ae2-a40f-881b1a03aff4",
"sales_organization": {
"id": "a7b878cc-5311-4769-be6b-a4c4e13c2dad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c269b1f0-df90-4484-a729-1150eef4a6b7",
"db_currency_id": "2327480b-4d7f-4572-b9e4-e9c3fd7bca06",
"db_language_id": "baae15ca-2c4a-4288-a52b-acde78b5b31f",
"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-06-18T14:43:13.1082108+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "62f03c9b-76f1-4837-a62a-ee88bd8bce1f",
"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": "a5ba1cac-29d3-473e-b3a0-a753cb77b38a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-18T14:43:13.1082108+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1ee08ac2-e07f-4d93-934c-8215d55867a1"
},
"suggested_date_start": "2026-06-18T14:43:13.1082108+00:00",
"skill_id": "e52c80d2-7a59-4b27-85a0-17e4277033be",
"skill_code": "sample string 32",
"skill": {
"id": "a481e5c1-4958-47ce-b653-b1aa51e6b55a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "25666879-abef-44a7-9716-1c31d24b261e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a7b878cc-5311-4769-be6b-a4c4e13c2dad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c269b1f0-df90-4484-a729-1150eef4a6b7",
"db_currency_id": "2327480b-4d7f-4572-b9e4-e9c3fd7bca06",
"db_language_id": "baae15ca-2c4a-4288-a52b-acde78b5b31f",
"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-06-18T14:43:13.1082108+00:00"
},
"modified_dateutc": "2026-06-18T14:43:13.1082108+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7e593189-0f03-4820-b14a-329189a55845",
"date_reported_by_company": "2026-06-18T14:43:13.1082108+00:00",
"id2": 36,
"company_id": "6592b8b9-b68c-40f8-946e-7614eb5f352d",
"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": "9ed1ad13-3c1c-4f00-b642-0b6dbd17e27d",
"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-06-18T14:43:13.1082108+00:00"
},
"work_instruction_details_id": "3124387f-5530-4ad7-9a10-e1a9533772cf",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8b39cf62-b9e4-4a22-b43a-6e19c7b11f3f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "dac70346-3092-4944-9d93-e0c226e504a1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-18T14:43:13.1082108+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": "4595353c-8cff-4c54-bc89-bd18c29020e7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-18T14:43:13.1082108+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.