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": "05f82a47-9a43-47c8-aa6f-6d1792cf7f72",
"jobs_id": "f8562c9b-630e-426f-8d6c-af6fe93eeeba",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "bd8e8f23-0cbc-4d2e-8d14-55bd49a649ef",
"_parent_id": "c83ad700-6892-4776-9ac5-636f8293e808",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0e372e5d-b38e-4dbb-bd5f-2c0aea613cd3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "52c77a1a-ba5d-47e3-b5cf-695605b0fb03",
"_parent_id": "6e38e25d-541f-45e6-bef4-b92b9b2555b2",
"root_parent_id": "2ba50955-68ee-41cb-a856-cd2dfb0af1d1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "77c03d8a-e8e1-4e74-9c99-a0c5371131ef",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "edfa96b3-d17d-4760-8f19-c1dfca5e62b5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0dad83db-fbe7-4dd0-b323-ccc84840213a",
"_parent_code": "sample string 6",
"sales_organization_id": "1f59ab6a-ba6a-496f-b848-ff3eab44c300",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "61217a62-5c14-4076-ba79-2346bbbd6c20",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0353ea82-ff1f-4871-937d-81d675c4479f",
"db_currency_id": "c5d29bd9-64da-42cc-99e4-d4a930f003cf",
"db_language_id": "f791d24e-fd82-4fb4-b85e-1a856747e4ed",
"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-09-11T04:23:07.5389463+00:00"
},
"modified_dateutc": "2026-09-11T04:23:07.5389463+00:00"
},
"equipment_model_id": "f15cbbff-6d21-4b8c-aa86-8f64545e3129",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c10713d6-2d0b-4867-a9e5-bdd19c0d9dd2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "398d54b0-a296-4ff8-9947-1f5359840a0b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d959d09a-46b3-4a8b-98bf-f72d91091776",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ed310c80-f89f-4d7f-a793-43636a40eeae",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "61217a62-5c14-4076-ba79-2346bbbd6c20",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0353ea82-ff1f-4871-937d-81d675c4479f",
"db_currency_id": "c5d29bd9-64da-42cc-99e4-d4a930f003cf",
"db_language_id": "f791d24e-fd82-4fb4-b85e-1a856747e4ed",
"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-09-11T04:23:07.5389463+00:00"
},
"modified_dateutc": "2026-09-11T04:23:07.5545719+00:00"
},
"equipment_family_id": "7a0f998d-4638-4c01-bd59-9f9bb3a411ff",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "edfa96b3-d17d-4760-8f19-c1dfca5e62b5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0dad83db-fbe7-4dd0-b323-ccc84840213a",
"_parent_code": "sample string 6",
"sales_organization_id": "1f59ab6a-ba6a-496f-b848-ff3eab44c300",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "61217a62-5c14-4076-ba79-2346bbbd6c20",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0353ea82-ff1f-4871-937d-81d675c4479f",
"db_currency_id": "c5d29bd9-64da-42cc-99e4-d4a930f003cf",
"db_language_id": "f791d24e-fd82-4fb4-b85e-1a856747e4ed",
"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-09-11T04:23:07.5389463+00:00"
},
"modified_dateutc": "2026-09-11T04:23:07.5389463+00:00"
},
"date_in_production_since": "2026-09-11T04:23:07.5545719+00:00",
"date_out_of_production_since": "2026-09-11T04:23:07.5545719+00:00",
"date_end_support": "2026-09-11T04:23:07.5545719+00:00",
"sales_organization_id": "4dd4be19-0179-43d1-a70a-15e32a4a54c2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "61217a62-5c14-4076-ba79-2346bbbd6c20",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0353ea82-ff1f-4871-937d-81d675c4479f",
"db_currency_id": "c5d29bd9-64da-42cc-99e4-d4a930f003cf",
"db_language_id": "f791d24e-fd82-4fb4-b85e-1a856747e4ed",
"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-09-11T04:23:07.5389463+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-09-11T04:23:07.5545719+00:00"
},
"project_status_id": "a59a9931-f5cb-4420-9020-386e0152484f",
"project_status_code": "sample string 10",
"project_status": {
"id": "52068b58-1491-45c4-81f5-b7eb08b1d09d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "400e6090-c507-4452-8265-7bc9b5819c37",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "61217a62-5c14-4076-ba79-2346bbbd6c20",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0353ea82-ff1f-4871-937d-81d675c4479f",
"db_currency_id": "c5d29bd9-64da-42cc-99e4-d4a930f003cf",
"db_language_id": "f791d24e-fd82-4fb4-b85e-1a856747e4ed",
"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-09-11T04:23:07.5389463+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-11T04:23:07.5545719+00:00"
},
"company_id": "19d7fb8e-1796-4de0-a295-f36ac4254ec3",
"company_code": "sample string 12",
"db_address_id": "87211688-e7e4-4157-9add-e0a62f9680da",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "954b1b31-0961-4504-b784-b67caae23997",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "08fd0ccd-fde4-4d09-930a-44f9c7df1fdc",
"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-09-11T04:23:07.5545719+00:00",
"date_create": "2026-09-11T04:23:07.5545719+00:00",
"date_update": "2026-09-11T04:23:07.5545719+00:00",
"updated_by_user_id": "f82b5612-5322-496a-8695-04dc6da55997",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-11T04:23:07.5545719+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-09-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-11T04:23:07.5545719+00:00",
"date_last_job": "2026-09-11T04:23:07.5545719+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-11T04:23:07.5545719+00:00",
"modified_dateutc": "2026-09-11T04:23:07.5545719+00:00",
"is_mobile_installation": true
},
"job_type_id": "010d32e1-a9ed-44ab-8250-8309491232c9",
"job_type_code": "sample string 7",
"job_type": {
"id": "e984366d-e15f-4ca7-951b-e3bfc5634d5e",
"name": "sample string 2",
"sales_organization_id": "1846c67a-663b-447a-be96-b6e513c632f6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-11T04:23:07.5545719+00:00",
"code": "sample string 7"
},
"job_priority_id": "4a0f68c4-7b7d-401a-9dc2-f16585e1029f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f34947c0-c18b-4a7c-ba60-beccdef9ce38",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "74a4a016-12fc-48d1-b904-420145e5e578",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "61217a62-5c14-4076-ba79-2346bbbd6c20",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0353ea82-ff1f-4871-937d-81d675c4479f",
"db_currency_id": "c5d29bd9-64da-42cc-99e4-d4a930f003cf",
"db_language_id": "f791d24e-fd82-4fb4-b85e-1a856747e4ed",
"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-09-11T04:23:07.5389463+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-11T04:23:07.5545719+00:00"
},
"job_status_id": "a4919e3d-53f4-4055-be8f-75cdf3db3229",
"job_status_code": "sample string 11",
"db_address_id": "6a14cce8-df09-4ff2-b077-ffd52ea5bc8f",
"contact_id": "d6747e41-5964-4f39-8741-475b9a661c9f",
"requested_by_company_id": "acf61fe1-7be7-4c9b-a40a-05fb1531d87a",
"requested_by_contact_id": "1172b8b0-d40c-4bc6-ad31-9deec4836ce0",
"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-09-11T04:23:07.5545719+00:00",
"due_date": "2026-09-11T04:23:07.5545719+00:00",
"date_create": "2026-09-11T04:23:07.5545719+00:00",
"date_update": "2026-09-11T04:23:07.5545719+00:00",
"date_closed": "2026-09-11T04:23:07.5545719+00:00",
"suggested_user_id": "1827e7c0-480c-4e9d-afc0-7e6f33b7075d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ff2d4f98-94c8-4483-ba0b-967a4358a7f2",
"db_language_id": "ff91d21e-aec2-49ec-99e7-db4af4f4dbcc",
"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-09-11T04:23:07.5545719+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "89d4a170-f9f0-4575-a405-0b73045c494b",
"sales_organization": {
"id": "61217a62-5c14-4076-ba79-2346bbbd6c20",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0353ea82-ff1f-4871-937d-81d675c4479f",
"db_currency_id": "c5d29bd9-64da-42cc-99e4-d4a930f003cf",
"db_language_id": "f791d24e-fd82-4fb4-b85e-1a856747e4ed",
"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-09-11T04:23:07.5389463+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5973c3d3-8812-4350-b39a-7dff919a329e",
"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": "887bc467-887e-4671-8d9d-e902fe3add87",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-11T04:23:07.5545719+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a68fe2d7-c844-4518-b690-c729f7bb126d"
},
"suggested_date_start": "2026-09-11T04:23:07.5545719+00:00",
"skill_id": "5589131c-f829-4f8a-b17e-5c89b03ac229",
"skill_code": "sample string 32",
"skill": {
"id": "81d3f1e6-71b9-4689-a453-63d4d240f8af",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1dc2b254-2713-4060-809c-259b0978f988",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "61217a62-5c14-4076-ba79-2346bbbd6c20",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0353ea82-ff1f-4871-937d-81d675c4479f",
"db_currency_id": "c5d29bd9-64da-42cc-99e4-d4a930f003cf",
"db_language_id": "f791d24e-fd82-4fb4-b85e-1a856747e4ed",
"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-09-11T04:23:07.5389463+00:00"
},
"modified_dateutc": "2026-09-11T04:23:07.5545719+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0a46e440-f891-434f-a29f-5c75e07628c7",
"date_reported_by_company": "2026-09-11T04:23:07.5545719+00:00",
"id2": 36,
"company_id": "ade41a74-054e-4b26-868e-2aa153e4cf6b",
"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": "4dc1fc75-be62-48e0-80c8-23753170a26a",
"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-09-11T04:23:07.5545719+00:00"
},
"work_instruction_details_id": "ac42ea63-c0df-4795-b77d-8fa5b094efaf",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b6daa6db-cd0e-496e-be48-83d990c40862",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "39b3cff0-945e-433f-a46b-0a04bd65c9b1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-11T04:23:07.5545719+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": "4fcad3a3-12df-4c0f-89d1-7949f6b665c6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-11T04:23:07.5545719+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.