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": "3718b5a0-4aa8-4584-8bf9-8e82fa9c0b2c",
"jobs_id": "5370fb2d-445b-4c45-9605-426712b9921f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d66b952c-c129-453c-819c-562bd40f7786",
"_parent_id": "3e37514e-ddad-4060-9247-6b38fe29a965",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a8d61d1f-bf53-4622-99a2-548b3a6fc1b4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1b0d769e-2523-4c27-9161-46d14dc6bdca",
"_parent_id": "bf389b62-8058-4081-bdd6-b98e59d1bad9",
"root_parent_id": "5a04036d-5d07-469f-a23a-3925850d1c77",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "09b95907-3a12-4ca6-ab6a-aa0b103da13b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "95f96926-45f7-423e-b90f-53eab469490d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "09fc6bf9-7279-4ace-a2a9-0899140feb2b",
"_parent_code": "sample string 6",
"sales_organization_id": "f5a67b24-fa0a-49df-af17-dcfa8ea1adc1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8e9c3819-7013-440e-a33a-62f59f9b2048",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63ee7179-d655-4538-a0d1-f3d3fb29748e",
"db_currency_id": "dfe99a2a-f56c-48dc-be37-d654fabe7026",
"db_language_id": "aa11cad6-b6c8-476c-bd44-e044405221e2",
"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-28T23:07:14.8898156+00:00"
},
"modified_dateutc": "2026-04-28T23:07:14.8898156+00:00"
},
"equipment_model_id": "55635302-e92b-44ef-9b22-aac78022c65b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5b22aeca-6dec-4827-854d-bdd7ae36714a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "21eb350f-8a2e-4e6a-926c-1733df2756ee",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "71562093-41d7-45c6-b6cc-cc19897af40f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f9a892e7-4b75-476c-97ca-029a474180e7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8e9c3819-7013-440e-a33a-62f59f9b2048",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63ee7179-d655-4538-a0d1-f3d3fb29748e",
"db_currency_id": "dfe99a2a-f56c-48dc-be37-d654fabe7026",
"db_language_id": "aa11cad6-b6c8-476c-bd44-e044405221e2",
"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-28T23:07:14.8898156+00:00"
},
"modified_dateutc": "2026-04-28T23:07:14.8898156+00:00"
},
"equipment_family_id": "c5f44a23-4d61-42e2-b448-c840e27d878a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "95f96926-45f7-423e-b90f-53eab469490d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "09fc6bf9-7279-4ace-a2a9-0899140feb2b",
"_parent_code": "sample string 6",
"sales_organization_id": "f5a67b24-fa0a-49df-af17-dcfa8ea1adc1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8e9c3819-7013-440e-a33a-62f59f9b2048",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63ee7179-d655-4538-a0d1-f3d3fb29748e",
"db_currency_id": "dfe99a2a-f56c-48dc-be37-d654fabe7026",
"db_language_id": "aa11cad6-b6c8-476c-bd44-e044405221e2",
"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-28T23:07:14.8898156+00:00"
},
"modified_dateutc": "2026-04-28T23:07:14.8898156+00:00"
},
"date_in_production_since": "2026-04-28T23:07:14.8898156+00:00",
"date_out_of_production_since": "2026-04-28T23:07:14.8898156+00:00",
"date_end_support": "2026-04-28T23:07:14.8898156+00:00",
"sales_organization_id": "50e0ad96-6463-4e6d-8fed-8dc2cc59ecbf",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8e9c3819-7013-440e-a33a-62f59f9b2048",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63ee7179-d655-4538-a0d1-f3d3fb29748e",
"db_currency_id": "dfe99a2a-f56c-48dc-be37-d654fabe7026",
"db_language_id": "aa11cad6-b6c8-476c-bd44-e044405221e2",
"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-28T23:07:14.8898156+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-28T23:07:14.8898156+00:00"
},
"project_status_id": "d3833db2-de5d-445a-9b45-c0b30e4130d6",
"project_status_code": "sample string 10",
"project_status": {
"id": "6cbee803-b50e-4423-a517-473b02b9bf3e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f4176a1e-1ee8-46e3-af09-d2b1b048f633",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8e9c3819-7013-440e-a33a-62f59f9b2048",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63ee7179-d655-4538-a0d1-f3d3fb29748e",
"db_currency_id": "dfe99a2a-f56c-48dc-be37-d654fabe7026",
"db_language_id": "aa11cad6-b6c8-476c-bd44-e044405221e2",
"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-28T23:07:14.8898156+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-28T23:07:14.8898156+00:00"
},
"company_id": "1c333127-e21d-4b92-b066-7612b4e14a13",
"company_code": "sample string 12",
"db_address_id": "85ed6990-a155-4ba3-b8e6-0e3da6ffdf0c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0d930c8b-bd9c-46ba-b633-7f700f14625f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7d1d8d8d-140d-4a2e-bc86-76ca82692719",
"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-28T23:07:14.8898156+00:00",
"date_create": "2026-04-28T23:07:14.8898156+00:00",
"date_update": "2026-04-28T23:07:14.8898156+00:00",
"updated_by_user_id": "c65ffa3f-d7bd-4be0-9ae2-6aa76ae71216",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-28T23:07:14.8898156+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-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-28T23:07:14.8898156+00:00",
"date_last_job": "2026-04-28T23:07:14.8898156+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-28T23:07:14.8898156+00:00",
"modified_dateutc": "2026-04-28T23:07:14.8898156+00:00",
"is_mobile_installation": true
},
"job_type_id": "22ffaf69-8ee5-4706-aece-e6a296e01d6a",
"job_type_code": "sample string 7",
"job_type": {
"id": "8a7864b5-003a-4861-80a6-d3e7a6d1d512",
"name": "sample string 2",
"sales_organization_id": "10f91ad3-7236-43d7-a4d1-5308615d4a2f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-28T23:07:14.8898156+00:00",
"code": "sample string 7"
},
"job_priority_id": "56ef0cb0-469a-4f65-9933-364bc184c5f5",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "848d9201-6686-48b9-865f-a6cf3ab7ce08",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "453dca9c-9a91-4315-8532-2633de9d4b9e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8e9c3819-7013-440e-a33a-62f59f9b2048",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63ee7179-d655-4538-a0d1-f3d3fb29748e",
"db_currency_id": "dfe99a2a-f56c-48dc-be37-d654fabe7026",
"db_language_id": "aa11cad6-b6c8-476c-bd44-e044405221e2",
"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-28T23:07:14.8898156+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-28T23:07:14.8898156+00:00"
},
"job_status_id": "f7723f2e-1888-4fb0-b1db-8de1da99927c",
"job_status_code": "sample string 11",
"db_address_id": "f2dcb147-4f00-482f-b7bf-8ef9b67a506f",
"contact_id": "7e36fe50-b9dd-4b31-8a23-90196a21243d",
"requested_by_company_id": "5d5eca06-328d-40fd-8bf7-2ce68635a50d",
"requested_by_contact_id": "cf388474-14c7-47ad-96d6-f01241745075",
"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-28T23:07:14.8898156+00:00",
"due_date": "2026-04-28T23:07:14.8898156+00:00",
"date_create": "2026-04-28T23:07:14.8898156+00:00",
"date_update": "2026-04-28T23:07:14.8898156+00:00",
"date_closed": "2026-04-28T23:07:14.8898156+00:00",
"suggested_user_id": "7207c700-73a3-4358-aa04-7cf0cf8ebf4a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "30958995-9c9b-4304-9faa-ea78689a778b",
"db_language_id": "f99eafb8-9de3-4390-9c8e-e7a844374efd",
"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-28T23:07:14.8898156+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "45f7d9b8-87f0-493f-af58-e6dafc9d3f19",
"sales_organization": {
"id": "8e9c3819-7013-440e-a33a-62f59f9b2048",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63ee7179-d655-4538-a0d1-f3d3fb29748e",
"db_currency_id": "dfe99a2a-f56c-48dc-be37-d654fabe7026",
"db_language_id": "aa11cad6-b6c8-476c-bd44-e044405221e2",
"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-28T23:07:14.8898156+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5a59ce87-215e-457e-ac79-a303b453975e",
"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": "dc6c38de-e277-43fe-a3eb-123be67a5e8b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-28T23:07:14.8898156+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3f855b9a-5a0e-4522-8ab4-13f8f762ee43"
},
"suggested_date_start": "2026-04-28T23:07:14.8898156+00:00",
"skill_id": "14dc9b83-d563-4896-a183-8e6008265699",
"skill_code": "sample string 32",
"skill": {
"id": "d3ed7311-ad50-4974-ae8b-9438defbb8d1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "40e88982-ae05-4d99-ad6a-2e9b688799dd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8e9c3819-7013-440e-a33a-62f59f9b2048",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63ee7179-d655-4538-a0d1-f3d3fb29748e",
"db_currency_id": "dfe99a2a-f56c-48dc-be37-d654fabe7026",
"db_language_id": "aa11cad6-b6c8-476c-bd44-e044405221e2",
"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-28T23:07:14.8898156+00:00"
},
"modified_dateutc": "2026-04-28T23:07:14.8898156+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9281fee0-af88-4959-aad8-ddec1d86ed02",
"date_reported_by_company": "2026-04-28T23:07:14.8898156+00:00",
"id2": 36,
"company_id": "856cb00b-cdbf-44f8-a4c4-159f602092fe",
"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": "4b60db7d-607f-44a3-8323-caaffbe3c986",
"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-28T23:07:14.8898156+00:00"
},
"work_instruction_details_id": "e76bb802-1afe-4ada-919f-aaeec452ddcd",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "83f99943-0a8b-42de-8269-fc4896e087c6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ad4b6ad1-5493-4064-98ca-dfccb8329047",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-28T23:07:14.8898156+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": "33e808ed-378c-49df-ab2c-44d946c250d1",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-28T23:07:14.8898156+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.