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": "8a0fdbac-11e0-485a-bb13-303ee60713cb",
"jobs_id": "58c8f7ef-92ab-4039-a845-e3a5f91fa43e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "551ab97f-3289-4c2b-b198-652e3aa643f7",
"_parent_id": "036e44c4-9669-44fc-b19a-6cda8b039be2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8fd748e0-1d91-477a-b46b-bc301b401c42",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9567d10b-ef47-4a2e-8773-e7d9098562db",
"_parent_id": "4b62e3b8-284b-4e4f-9af1-092a26d04b7c",
"root_parent_id": "32f02218-3d40-4723-baf8-e8a8f77bda2d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f1ddbca2-974d-4d14-a0de-471ee1d3d36c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4ecdbfac-a5ea-49e7-8d37-185550aa5937",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ef7e9467-dd3e-4c2c-815f-cbfdbab4b528",
"_parent_code": "sample string 6",
"sales_organization_id": "3e3e948c-d3e3-4718-a796-71c87d00ed3c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cf560d25-2453-479d-ba66-3052ea8fc273",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db69815b-497c-49ed-8575-de11c0f0c6a4",
"db_currency_id": "6e4dabde-9581-49fd-84b2-0db3ec2bf3a7",
"db_language_id": "3cc873f5-9068-4dc0-a0b7-c3641bcbe908",
"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-30T23:29:36.3317447+00:00"
},
"modified_dateutc": "2026-06-30T23:29:36.3317447+00:00"
},
"equipment_model_id": "78e2e718-b325-428e-a4c4-f002c4161ec7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ce2401ae-c73b-458a-a838-c7de3c3dbfe7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4b1dfe35-819b-46fa-8487-e436eec2b920",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2f327a63-d769-4773-9d1d-228b208901c5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ec1cddd7-21d2-4a01-88f5-52381f763fa4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cf560d25-2453-479d-ba66-3052ea8fc273",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db69815b-497c-49ed-8575-de11c0f0c6a4",
"db_currency_id": "6e4dabde-9581-49fd-84b2-0db3ec2bf3a7",
"db_language_id": "3cc873f5-9068-4dc0-a0b7-c3641bcbe908",
"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-30T23:29:36.3317447+00:00"
},
"modified_dateutc": "2026-06-30T23:29:36.3317447+00:00"
},
"equipment_family_id": "991ec4d2-935b-434f-8871-83643cefed6a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4ecdbfac-a5ea-49e7-8d37-185550aa5937",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ef7e9467-dd3e-4c2c-815f-cbfdbab4b528",
"_parent_code": "sample string 6",
"sales_organization_id": "3e3e948c-d3e3-4718-a796-71c87d00ed3c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cf560d25-2453-479d-ba66-3052ea8fc273",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db69815b-497c-49ed-8575-de11c0f0c6a4",
"db_currency_id": "6e4dabde-9581-49fd-84b2-0db3ec2bf3a7",
"db_language_id": "3cc873f5-9068-4dc0-a0b7-c3641bcbe908",
"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-30T23:29:36.3317447+00:00"
},
"modified_dateutc": "2026-06-30T23:29:36.3317447+00:00"
},
"date_in_production_since": "2026-06-30T23:29:36.3317447+00:00",
"date_out_of_production_since": "2026-06-30T23:29:36.3317447+00:00",
"date_end_support": "2026-06-30T23:29:36.3317447+00:00",
"sales_organization_id": "f589041a-0bf4-48db-a0cd-9946c43ddbfc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "cf560d25-2453-479d-ba66-3052ea8fc273",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db69815b-497c-49ed-8575-de11c0f0c6a4",
"db_currency_id": "6e4dabde-9581-49fd-84b2-0db3ec2bf3a7",
"db_language_id": "3cc873f5-9068-4dc0-a0b7-c3641bcbe908",
"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-30T23:29:36.3317447+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-30T23:29:36.3317447+00:00"
},
"project_status_id": "a211ef8a-00fe-40fe-8333-fe493cb579b9",
"project_status_code": "sample string 10",
"project_status": {
"id": "ef5d7f92-621c-4ea4-807d-0a4c6a1fe6ca",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fc282d2d-0461-464c-8405-ca3365ad8cff",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cf560d25-2453-479d-ba66-3052ea8fc273",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db69815b-497c-49ed-8575-de11c0f0c6a4",
"db_currency_id": "6e4dabde-9581-49fd-84b2-0db3ec2bf3a7",
"db_language_id": "3cc873f5-9068-4dc0-a0b7-c3641bcbe908",
"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-30T23:29:36.3317447+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-30T23:29:36.3317447+00:00"
},
"company_id": "d0219261-9cc2-4a68-ae45-f9f4d75866e4",
"company_code": "sample string 12",
"db_address_id": "6d653994-acc1-40b3-ab53-af62c5856fd0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cf848a59-1545-422c-b4d2-262f0eeb2432",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d843ddd5-984d-4053-a8f6-31e753013512",
"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-30T23:29:36.3317447+00:00",
"date_create": "2026-06-30T23:29:36.3317447+00:00",
"date_update": "2026-06-30T23:29:36.3317447+00:00",
"updated_by_user_id": "d7cd47a8-99da-48ee-bd2f-fc1a6a17fdfa",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-30T23:29:36.3317447+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-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-30T23:29:36.3317447+00:00",
"date_last_job": "2026-06-30T23:29:36.3317447+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-30T23:29:36.3317447+00:00",
"modified_dateutc": "2026-06-30T23:29:36.3317447+00:00",
"is_mobile_installation": true
},
"job_type_id": "69448c00-478c-4aca-b723-bddbad0db338",
"job_type_code": "sample string 7",
"job_type": {
"id": "3fd83bb8-8008-4fe0-97b2-7b9e3a465ef0",
"name": "sample string 2",
"sales_organization_id": "cecab44e-fc87-4c10-b15d-46952bdcae80",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-30T23:29:36.3317447+00:00",
"code": "sample string 7"
},
"job_priority_id": "dc822467-042b-4158-aa02-d1ca0fbda9b9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e2ae0f54-0538-4d46-a8ca-e5703d84d2a8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f0c24472-2db5-4677-98c1-feab63a6ddeb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cf560d25-2453-479d-ba66-3052ea8fc273",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db69815b-497c-49ed-8575-de11c0f0c6a4",
"db_currency_id": "6e4dabde-9581-49fd-84b2-0db3ec2bf3a7",
"db_language_id": "3cc873f5-9068-4dc0-a0b7-c3641bcbe908",
"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-30T23:29:36.3317447+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-30T23:29:36.3317447+00:00"
},
"job_status_id": "e02b058e-8498-4c89-88d1-d24d8a0848b8",
"job_status_code": "sample string 11",
"db_address_id": "69011216-15f4-4d9e-9626-2e1de2ebcf5a",
"contact_id": "7f4fe675-8e1f-478b-a6c8-31c0dcd14f76",
"requested_by_company_id": "472c921a-3f7c-453b-b449-095a818e8288",
"requested_by_contact_id": "590afc5c-6b9e-4b7b-ba57-b6a939eef425",
"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-30T23:29:36.3317447+00:00",
"due_date": "2026-06-30T23:29:36.3317447+00:00",
"date_create": "2026-06-30T23:29:36.3317447+00:00",
"date_update": "2026-06-30T23:29:36.3317447+00:00",
"date_closed": "2026-06-30T23:29:36.3317447+00:00",
"suggested_user_id": "efad7d63-0efb-414a-8be0-ddf3bc63d00c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b1588a05-7fd1-4c8e-9504-cf6a144b3b8d",
"db_language_id": "b96cf533-664c-4b78-98e0-b7543302f56f",
"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-30T23:29:36.3317447+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "737c8711-07fd-49c8-b979-5d162a19502d",
"sales_organization": {
"id": "cf560d25-2453-479d-ba66-3052ea8fc273",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db69815b-497c-49ed-8575-de11c0f0c6a4",
"db_currency_id": "6e4dabde-9581-49fd-84b2-0db3ec2bf3a7",
"db_language_id": "3cc873f5-9068-4dc0-a0b7-c3641bcbe908",
"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-30T23:29:36.3317447+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4e3509d6-68c0-436a-bc7d-a629df0059f3",
"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": "eccf9d39-0cfb-4ff3-880d-5dc83f972f63",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-30T23:29:36.3317447+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8502fd92-9e4c-4732-98eb-cb112014dc9a"
},
"suggested_date_start": "2026-06-30T23:29:36.3317447+00:00",
"skill_id": "e2528aff-4635-4f1d-a211-be1aa38fe4ac",
"skill_code": "sample string 32",
"skill": {
"id": "faea2183-2c07-43ad-a5d0-c62344f5ec58",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "57813c8f-f8a4-4ece-aeb5-49cea1d62976",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cf560d25-2453-479d-ba66-3052ea8fc273",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db69815b-497c-49ed-8575-de11c0f0c6a4",
"db_currency_id": "6e4dabde-9581-49fd-84b2-0db3ec2bf3a7",
"db_language_id": "3cc873f5-9068-4dc0-a0b7-c3641bcbe908",
"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-30T23:29:36.3317447+00:00"
},
"modified_dateutc": "2026-06-30T23:29:36.3317447+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ce8f7bbf-ff54-43ef-a835-2dad5e439020",
"date_reported_by_company": "2026-06-30T23:29:36.3317447+00:00",
"id2": 36,
"company_id": "9b9c3e60-7ef4-4f3b-a09c-10727ba98c50",
"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": "6108e00a-9425-4cdb-9e1c-ce05ddb4bdbb",
"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-30T23:29:36.3317447+00:00"
},
"work_instruction_details_id": "e1ab26c2-5e44-4a86-8227-5fdee7390dfa",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "814b52b5-e17d-4d96-b63b-8abfb19f038f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1622bdad-a68e-4170-a76e-3112b94b5d61",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-30T23:29:36.3317447+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": "d8e09f7a-e9e7-49d8-8b64-5d1cc739ba7d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-30T23:29:36.3317447+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.