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": "f9c465a3-08d1-454e-a9ba-208a503a7a5e",
"jobs_id": "8a3f95ba-5589-4c4a-b2dd-b70463d798b4",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6d41fb51-c3c5-4d55-91da-eb7720ed1610",
"_parent_id": "d10b9593-e68e-49f2-87a2-faf623deab3e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9a947e48-9561-4729-abdb-7fdef3069c28",
"project_reference_back_office": "sample string 5",
"project": {
"id": "869c61bb-ca62-497b-bf19-760186d7abee",
"_parent_id": "d7545910-5d29-4b0d-bf7f-6acf43e9bc1c",
"root_parent_id": "00062df4-c4b0-4768-843a-6b6cbfa5b8f2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7268280f-97e6-4735-a6d8-1c0e1379fa25",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d1b3a840-d245-4cf8-ba65-cda629513092",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "84b0e837-b918-4a08-ae19-36e5488cda91",
"_parent_code": "sample string 6",
"sales_organization_id": "e4507a04-ad5c-4f41-a6e1-ae44dafba384",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "84897eef-4f6a-4a28-ae16-2000e9163408",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b52cbc98-4be6-4ae0-b177-e7574e3e8150",
"db_currency_id": "5b9f7b06-5cb4-40fb-b935-700784d53e8b",
"db_language_id": "56537ca7-609f-4492-8817-fd6dbc22f7f5",
"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-11-12T13:44:33.1827889+00:00"
},
"modified_dateutc": "2026-11-12T13:44:33.1827889+00:00"
},
"equipment_model_id": "3d72678c-7813-4b41-8d38-8426809d150c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "057995bb-0b0e-4d83-9f6c-04de50b3bbf6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "44302f01-d4ff-40e4-a45c-c33a3cdb8943",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2bf710df-e760-4653-839e-3c2f398d1ce0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "995a4a53-42cb-41ad-8b6c-d27d17c8d701",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "84897eef-4f6a-4a28-ae16-2000e9163408",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b52cbc98-4be6-4ae0-b177-e7574e3e8150",
"db_currency_id": "5b9f7b06-5cb4-40fb-b935-700784d53e8b",
"db_language_id": "56537ca7-609f-4492-8817-fd6dbc22f7f5",
"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-11-12T13:44:33.1827889+00:00"
},
"modified_dateutc": "2026-11-12T13:44:33.1827889+00:00"
},
"equipment_family_id": "68897548-20a5-4a8e-a3d7-efb5f4d371ce",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d1b3a840-d245-4cf8-ba65-cda629513092",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "84b0e837-b918-4a08-ae19-36e5488cda91",
"_parent_code": "sample string 6",
"sales_organization_id": "e4507a04-ad5c-4f41-a6e1-ae44dafba384",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "84897eef-4f6a-4a28-ae16-2000e9163408",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b52cbc98-4be6-4ae0-b177-e7574e3e8150",
"db_currency_id": "5b9f7b06-5cb4-40fb-b935-700784d53e8b",
"db_language_id": "56537ca7-609f-4492-8817-fd6dbc22f7f5",
"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-11-12T13:44:33.1827889+00:00"
},
"modified_dateutc": "2026-11-12T13:44:33.1827889+00:00"
},
"date_in_production_since": "2026-11-12T13:44:33.1827889+00:00",
"date_out_of_production_since": "2026-11-12T13:44:33.1827889+00:00",
"date_end_support": "2026-11-12T13:44:33.1827889+00:00",
"sales_organization_id": "b36dfc3c-e8b5-4f88-9cb9-725adba47002",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "84897eef-4f6a-4a28-ae16-2000e9163408",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b52cbc98-4be6-4ae0-b177-e7574e3e8150",
"db_currency_id": "5b9f7b06-5cb4-40fb-b935-700784d53e8b",
"db_language_id": "56537ca7-609f-4492-8817-fd6dbc22f7f5",
"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-11-12T13:44:33.1827889+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-11-12T13:44:33.1827889+00:00"
},
"project_status_id": "2c5ed39e-e626-4b0d-836f-862a8366be04",
"project_status_code": "sample string 10",
"project_status": {
"id": "1f4c6c81-e209-42d9-a21c-1512868d866d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4dd58d67-c31a-4eb1-ae51-78a40e1eb353",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "84897eef-4f6a-4a28-ae16-2000e9163408",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b52cbc98-4be6-4ae0-b177-e7574e3e8150",
"db_currency_id": "5b9f7b06-5cb4-40fb-b935-700784d53e8b",
"db_language_id": "56537ca7-609f-4492-8817-fd6dbc22f7f5",
"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-11-12T13:44:33.1827889+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-12T13:44:33.1827889+00:00"
},
"company_id": "7d9d26b7-3dc3-4638-9f97-540f86f5bba2",
"company_code": "sample string 12",
"db_address_id": "4576a22b-0f0a-4e84-bda7-d649a16cf3a0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "38b7b9d5-d35c-4070-bed9-a67e0d134cea",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "99835776-4357-4507-9471-266cfa614ea0",
"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-11-12T13:44:33.1827889+00:00",
"date_create": "2026-11-12T13:44:33.1827889+00:00",
"date_update": "2026-11-12T13:44:33.1827889+00:00",
"updated_by_user_id": "88637c0a-c0f6-47ed-aea8-2dba06c250ae",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-12T13:44:33.1827889+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-11-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-12T13:44:33.1827889+00:00",
"date_last_job": "2026-11-12T13:44:33.1827889+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-12T13:44:33.1827889+00:00",
"modified_dateutc": "2026-11-12T13:44:33.1827889+00:00",
"is_mobile_installation": true
},
"job_type_id": "8df1831c-819e-473b-98a5-bba0d3da4a7a",
"job_type_code": "sample string 7",
"job_type": {
"id": "76503a4d-cc6b-44da-a7d8-bdb87f4af048",
"name": "sample string 2",
"sales_organization_id": "ac529345-a8a1-46a6-ba43-17c46d72a06d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-12T13:44:33.1827889+00:00",
"code": "sample string 7"
},
"job_priority_id": "e0248ccd-fbd0-424e-a0b0-131e365da2d6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "46682952-53b2-458e-b7f2-1a4d1c629511",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0a21c6fd-85a8-4704-b05e-c4e3b56718c8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "84897eef-4f6a-4a28-ae16-2000e9163408",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b52cbc98-4be6-4ae0-b177-e7574e3e8150",
"db_currency_id": "5b9f7b06-5cb4-40fb-b935-700784d53e8b",
"db_language_id": "56537ca7-609f-4492-8817-fd6dbc22f7f5",
"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-11-12T13:44:33.1827889+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-12T13:44:33.1827889+00:00"
},
"job_status_id": "4d9bf138-8627-4e73-b43e-7524bebea1d0",
"job_status_code": "sample string 11",
"db_address_id": "3e2e4cbc-722e-4508-a579-e65f217452cc",
"contact_id": "aba74795-102c-4904-a398-515591dc8230",
"requested_by_company_id": "3ccd3804-838f-4db3-9a17-f4210ce1ad8e",
"requested_by_contact_id": "a05a69a7-9a60-453f-abcf-da5b04a83148",
"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-11-12T13:44:33.1827889+00:00",
"due_date": "2026-11-12T13:44:33.1827889+00:00",
"date_create": "2026-11-12T13:44:33.1827889+00:00",
"date_update": "2026-11-12T13:44:33.1827889+00:00",
"date_closed": "2026-11-12T13:44:33.1827889+00:00",
"suggested_user_id": "c1e79a76-42ce-49b3-b37a-2daf942b4cf2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9604128e-91e9-4622-babd-c71e7c6a94ac",
"db_language_id": "201678a9-19d2-45e5-bb87-de4fed2b47de",
"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-11-12T13:44:33.1827889+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7977b45a-9036-4d84-8a21-7dfde2a0afa4",
"sales_organization": {
"id": "84897eef-4f6a-4a28-ae16-2000e9163408",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b52cbc98-4be6-4ae0-b177-e7574e3e8150",
"db_currency_id": "5b9f7b06-5cb4-40fb-b935-700784d53e8b",
"db_language_id": "56537ca7-609f-4492-8817-fd6dbc22f7f5",
"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-11-12T13:44:33.1827889+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4bff1f1e-13c5-4cfe-8a93-d338c0a027e4",
"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": "82398443-79f6-4ffa-aa08-8b8fbf8463e3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-12T13:44:33.1827889+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4c3ec656-5072-40f8-99c3-aee22d2bb56f"
},
"suggested_date_start": "2026-11-12T13:44:33.1827889+00:00",
"skill_id": "99873cc4-7a51-4952-95d0-81509d5575d6",
"skill_code": "sample string 32",
"skill": {
"id": "1e8531aa-1c88-4a97-b0e2-de5b0c309397",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "bea342d4-de95-4492-8b53-223d3ad56360",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "84897eef-4f6a-4a28-ae16-2000e9163408",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b52cbc98-4be6-4ae0-b177-e7574e3e8150",
"db_currency_id": "5b9f7b06-5cb4-40fb-b935-700784d53e8b",
"db_language_id": "56537ca7-609f-4492-8817-fd6dbc22f7f5",
"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-11-12T13:44:33.1827889+00:00"
},
"modified_dateutc": "2026-11-12T13:44:33.1827889+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d8dec805-dbb0-4e32-9f2b-5c5991020bd3",
"date_reported_by_company": "2026-11-12T13:44:33.1827889+00:00",
"id2": 36,
"company_id": "6f9796dc-58db-4b34-aee5-6c619a8ecd1f",
"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": "f86c4676-685d-4b5b-b86b-ef50493d3d10",
"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-11-12T13:44:33.1827889+00:00"
},
"work_instruction_details_id": "93bc9f5f-d3ef-4878-892a-26aae62e8789",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a4536359-b58c-4a83-9690-81b0d37c7f80",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "da3053d2-9c41-4d3f-9b3f-a19d2740bae8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-12T13:44:33.1827889+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": "c36168b4-f094-4d63-8b97-6ebda15eea8f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-12T13:44:33.1827889+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.