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": "2eeac51c-046e-4c65-bf50-06c36da369c3",
"jobs_id": "13688556-5044-4aac-90fe-c949495c04b7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "00bf7a89-31ec-47a9-8ccf-817f0a2e8109",
"_parent_id": "cffab387-9786-44cc-ae4f-21b17afe3f6c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5f13f4be-7af5-4bb2-8e65-c8246724e872",
"project_reference_back_office": "sample string 5",
"project": {
"id": "cf3f8f86-cee8-47a2-985a-2474e4343f42",
"_parent_id": "ef471175-c341-4bbb-a3e7-05621152dd52",
"root_parent_id": "8f4a1b8d-81eb-4f59-8364-1aeaf88f43e6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9269d0bc-8e4a-4480-b0af-ff5ec6d81c70",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "42a2801c-0883-4e6e-acdf-08553b37c493",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "16747a84-95ef-4eb2-b329-ec26d31995e9",
"_parent_code": "sample string 6",
"sales_organization_id": "b618537b-3104-4e1e-b101-3d124da593a9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f10d25fc-9a19-4542-aa78-9ca4af13bcd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56bdeb68-b84b-4428-b5f4-b1b07275dc84",
"db_currency_id": "cafbd719-dba6-469b-91d3-7c64b4374981",
"db_language_id": "ea4c19d2-2acc-42a0-9135-1a35ce7de753",
"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-02-18T05:41:14.3632496+00:00"
},
"modified_dateutc": "2026-02-18T05:41:14.3632496+00:00"
},
"equipment_model_id": "2d983696-da12-42c5-bb31-149c84539b87",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "37aa208f-7a29-441e-bc8c-ce316e2311d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ec202ed6-6452-4b59-a297-d03e0e400db6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "aa1070fd-35c2-49fb-a8d6-efa2c1a2704f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3ba7118b-c395-415c-b0c4-5aa33b40e2fa",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f10d25fc-9a19-4542-aa78-9ca4af13bcd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56bdeb68-b84b-4428-b5f4-b1b07275dc84",
"db_currency_id": "cafbd719-dba6-469b-91d3-7c64b4374981",
"db_language_id": "ea4c19d2-2acc-42a0-9135-1a35ce7de753",
"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-02-18T05:41:14.3632496+00:00"
},
"modified_dateutc": "2026-02-18T05:41:14.3632496+00:00"
},
"equipment_family_id": "f192c8d6-28fa-492d-8883-eb03f5f713cf",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "42a2801c-0883-4e6e-acdf-08553b37c493",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "16747a84-95ef-4eb2-b329-ec26d31995e9",
"_parent_code": "sample string 6",
"sales_organization_id": "b618537b-3104-4e1e-b101-3d124da593a9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f10d25fc-9a19-4542-aa78-9ca4af13bcd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56bdeb68-b84b-4428-b5f4-b1b07275dc84",
"db_currency_id": "cafbd719-dba6-469b-91d3-7c64b4374981",
"db_language_id": "ea4c19d2-2acc-42a0-9135-1a35ce7de753",
"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-02-18T05:41:14.3632496+00:00"
},
"modified_dateutc": "2026-02-18T05:41:14.3632496+00:00"
},
"date_in_production_since": "2026-02-18T05:41:14.3632496+00:00",
"date_out_of_production_since": "2026-02-18T05:41:14.3632496+00:00",
"date_end_support": "2026-02-18T05:41:14.3632496+00:00",
"sales_organization_id": "379b4f0a-bb15-4da0-824f-856457d47c85",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f10d25fc-9a19-4542-aa78-9ca4af13bcd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56bdeb68-b84b-4428-b5f4-b1b07275dc84",
"db_currency_id": "cafbd719-dba6-469b-91d3-7c64b4374981",
"db_language_id": "ea4c19d2-2acc-42a0-9135-1a35ce7de753",
"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-02-18T05:41:14.3632496+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-02-18T05:41:14.3632496+00:00"
},
"project_status_id": "e58b4a4c-6b6f-45c3-ab00-d4e03ce8ed4b",
"project_status_code": "sample string 10",
"project_status": {
"id": "987cb6c4-103e-420d-98ff-accf7e987005",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "96945f68-7a45-4fe7-b009-b720ea0a236e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f10d25fc-9a19-4542-aa78-9ca4af13bcd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56bdeb68-b84b-4428-b5f4-b1b07275dc84",
"db_currency_id": "cafbd719-dba6-469b-91d3-7c64b4374981",
"db_language_id": "ea4c19d2-2acc-42a0-9135-1a35ce7de753",
"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-02-18T05:41:14.3632496+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-18T05:41:14.3632496+00:00"
},
"company_id": "97718b18-8195-46b8-b052-ad8d7ed98a71",
"company_code": "sample string 12",
"db_address_id": "02d66b0e-88c5-487d-9ebf-a0bd16bf67ff",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f9bf1f5e-ea15-4771-b844-95db63d81f1e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0e6b9209-2c05-4182-8d45-07b238cd00d7",
"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-02-18T05:41:14.3632496+00:00",
"date_create": "2026-02-18T05:41:14.3632496+00:00",
"date_update": "2026-02-18T05:41:14.3632496+00:00",
"updated_by_user_id": "2a999300-fa2a-46f4-9363-a5669374cffe",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-18T05:41:14.3632496+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-02-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-18T05:41:14.3632496+00:00",
"date_last_job": "2026-02-18T05:41:14.3632496+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-18T05:41:14.3632496+00:00",
"modified_dateutc": "2026-02-18T05:41:14.3632496+00:00",
"is_mobile_installation": true
},
"job_type_id": "081a949f-9f7e-441e-9b05-d4c3e74e8c89",
"job_type_code": "sample string 7",
"job_type": {
"id": "eddac4b5-1224-4e57-a973-3e7ae0eea578",
"name": "sample string 2",
"sales_organization_id": "650df154-8721-47ac-90d2-19a388b664f5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-18T05:41:14.3632496+00:00",
"code": "sample string 7"
},
"job_priority_id": "dda2b100-e6db-4d0a-a68f-236db97d3918",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "96981ef4-1724-4ec1-ac3d-8e4657eec823",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "77a59754-31f6-4fa0-982c-de7ea2b98900",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f10d25fc-9a19-4542-aa78-9ca4af13bcd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56bdeb68-b84b-4428-b5f4-b1b07275dc84",
"db_currency_id": "cafbd719-dba6-469b-91d3-7c64b4374981",
"db_language_id": "ea4c19d2-2acc-42a0-9135-1a35ce7de753",
"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-02-18T05:41:14.3632496+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-18T05:41:14.3632496+00:00"
},
"job_status_id": "c2a9a825-8ca4-400a-b9a2-911e0ec80b29",
"job_status_code": "sample string 11",
"db_address_id": "c2a6e94f-c791-46f0-95b6-9b2d3425bccf",
"contact_id": "cb74faec-aa14-41be-8925-ed9b1ca3a49c",
"requested_by_company_id": "7ff609ee-0a8d-4b0b-b340-c32f342eabf3",
"requested_by_contact_id": "79f8a7f3-ae28-450e-9796-9ee857870305",
"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-02-18T05:41:14.3632496+00:00",
"due_date": "2026-02-18T05:41:14.3632496+00:00",
"date_create": "2026-02-18T05:41:14.3632496+00:00",
"date_update": "2026-02-18T05:41:14.3632496+00:00",
"date_closed": "2026-02-18T05:41:14.3632496+00:00",
"suggested_user_id": "54cabdd3-bd57-4e15-8c3f-a39d3886a059",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "988ff274-9245-4564-a63b-8494d9814a0d",
"db_language_id": "9aac445b-5b84-4041-84b3-58802dcf4c22",
"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-02-18T05:41:14.3632496+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6774054a-3305-4c24-86d0-8c42e4c3704f",
"sales_organization": {
"id": "f10d25fc-9a19-4542-aa78-9ca4af13bcd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56bdeb68-b84b-4428-b5f4-b1b07275dc84",
"db_currency_id": "cafbd719-dba6-469b-91d3-7c64b4374981",
"db_language_id": "ea4c19d2-2acc-42a0-9135-1a35ce7de753",
"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-02-18T05:41:14.3632496+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b0405c07-db67-4fe4-a5a6-e1ec5760559d",
"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": "5442eb34-ffe2-464d-ad99-5b99d8053edb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-18T05:41:14.3632496+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "576746d4-6859-4884-aad3-7240da46cd5e"
},
"suggested_date_start": "2026-02-18T05:41:14.3632496+00:00",
"skill_id": "afab71d9-ebf9-448e-ac3e-589e41615d1a",
"skill_code": "sample string 32",
"skill": {
"id": "44f069fd-2a13-4e7b-b2d8-aa46db9ebb70",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0390abed-b4f6-411d-9abc-3fbb52eaa3b9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f10d25fc-9a19-4542-aa78-9ca4af13bcd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56bdeb68-b84b-4428-b5f4-b1b07275dc84",
"db_currency_id": "cafbd719-dba6-469b-91d3-7c64b4374981",
"db_language_id": "ea4c19d2-2acc-42a0-9135-1a35ce7de753",
"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-02-18T05:41:14.3632496+00:00"
},
"modified_dateutc": "2026-02-18T05:41:14.3632496+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d93be7a0-a348-4a0a-9489-51caa4623cb9",
"date_reported_by_company": "2026-02-18T05:41:14.3632496+00:00",
"id2": 36,
"company_id": "7e29e672-7a8d-4dbe-8ad1-b057b74e8a31",
"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": "aad0d8aa-f9ed-433c-aaff-4d07e7eab65e",
"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-02-18T05:41:14.3632496+00:00"
},
"work_instruction_details_id": "bc15345e-1cc4-48c3-ab5c-209787d60c4d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7a22b874-7e5a-43ee-bd20-7ce30afbea6e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "04ecdb01-921c-415a-ba0f-2a83befadeea",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-18T05:41:14.3632496+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": "546c6231-92ca-45fa-8c5c-d988a5a917f5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-18T05:41:14.3632496+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.