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": "fa7e9165-5a35-49c4-a679-e795b8d03ddb",
"jobs_id": "1d084e3a-497f-4f3d-92c3-a131567c6c23",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "081d17ae-51b3-4012-bd78-ee04dcae7860",
"_parent_id": "32b0992b-042e-41e2-aae8-b6d51b1a0fbd",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "734dc4e3-2c96-42eb-a994-6b65b49d30e5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2ba39fde-5b3d-4957-8bba-69ae64ee0188",
"_parent_id": "77f2cdd6-6afb-4a25-a034-68291861b897",
"root_parent_id": "f113294e-2de7-4fa6-86c3-a6ed9d58cfd0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6725d26a-3a97-45ad-a847-40a464c86091",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3ee9b5e4-c6f8-4abe-bd99-eaff9c62092b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7d07bed7-17b2-4788-977e-c15a3c86273a",
"_parent_code": "sample string 6",
"sales_organization_id": "95c09cfa-87ed-4704-aa6a-c653a71085bd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e60d8dc9-ed46-472c-917f-53f8bc42679c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a55f29eb-22a3-4386-9ebf-8a3f3e4fc1f8",
"db_currency_id": "5b2d8d4e-a4dd-4110-a7cd-1fb9dcc878b4",
"db_language_id": "aa18d671-dcaa-4c10-a7c1-48da72676833",
"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-07-24T08:52:30.1012705+00:00"
},
"modified_dateutc": "2026-07-24T08:52:30.1012705+00:00"
},
"equipment_model_id": "779d0499-95aa-4df9-a703-4113acf10bfd",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7e48e756-6d74-4b07-b993-0bc4cb11c2eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6bf0eb08-2c9c-429f-9ee7-31da9c3ed298",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "58fefd10-7e63-4257-8653-4c21d67d6cb6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4fe89ee0-2644-415b-a03c-393055d4b50c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e60d8dc9-ed46-472c-917f-53f8bc42679c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a55f29eb-22a3-4386-9ebf-8a3f3e4fc1f8",
"db_currency_id": "5b2d8d4e-a4dd-4110-a7cd-1fb9dcc878b4",
"db_language_id": "aa18d671-dcaa-4c10-a7c1-48da72676833",
"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-07-24T08:52:30.1012705+00:00"
},
"modified_dateutc": "2026-07-24T08:52:30.1012705+00:00"
},
"equipment_family_id": "1f43b620-e606-49bd-8116-3b757894d5e6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3ee9b5e4-c6f8-4abe-bd99-eaff9c62092b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7d07bed7-17b2-4788-977e-c15a3c86273a",
"_parent_code": "sample string 6",
"sales_organization_id": "95c09cfa-87ed-4704-aa6a-c653a71085bd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e60d8dc9-ed46-472c-917f-53f8bc42679c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a55f29eb-22a3-4386-9ebf-8a3f3e4fc1f8",
"db_currency_id": "5b2d8d4e-a4dd-4110-a7cd-1fb9dcc878b4",
"db_language_id": "aa18d671-dcaa-4c10-a7c1-48da72676833",
"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-07-24T08:52:30.1012705+00:00"
},
"modified_dateutc": "2026-07-24T08:52:30.1012705+00:00"
},
"date_in_production_since": "2026-07-24T08:52:30.1012705+00:00",
"date_out_of_production_since": "2026-07-24T08:52:30.1012705+00:00",
"date_end_support": "2026-07-24T08:52:30.1012705+00:00",
"sales_organization_id": "05583474-b427-4b42-9f31-1132e264c263",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e60d8dc9-ed46-472c-917f-53f8bc42679c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a55f29eb-22a3-4386-9ebf-8a3f3e4fc1f8",
"db_currency_id": "5b2d8d4e-a4dd-4110-a7cd-1fb9dcc878b4",
"db_language_id": "aa18d671-dcaa-4c10-a7c1-48da72676833",
"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-07-24T08:52:30.1012705+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-07-24T08:52:30.1012705+00:00"
},
"project_status_id": "43515b76-3b7d-4a96-b6b0-b3fd1647df3c",
"project_status_code": "sample string 10",
"project_status": {
"id": "7ee79b20-950f-469b-a0fe-8676294dd24a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4a152f51-ee96-47f0-b457-11465217cbfb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e60d8dc9-ed46-472c-917f-53f8bc42679c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a55f29eb-22a3-4386-9ebf-8a3f3e4fc1f8",
"db_currency_id": "5b2d8d4e-a4dd-4110-a7cd-1fb9dcc878b4",
"db_language_id": "aa18d671-dcaa-4c10-a7c1-48da72676833",
"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-07-24T08:52:30.1012705+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-24T08:52:30.1012705+00:00"
},
"company_id": "1fcc18a9-8dd2-4a33-b494-93ff29aba575",
"company_code": "sample string 12",
"db_address_id": "28ab6235-4df6-4258-9e40-d49274bfc7c0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "dad33659-992b-403d-a92d-0bfcaac2938a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "95479ea2-bbe9-49ed-a706-8fce8c5aa311",
"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-07-24T08:52:30.1012705+00:00",
"date_create": "2026-07-24T08:52:30.1012705+00:00",
"date_update": "2026-07-24T08:52:30.1012705+00:00",
"updated_by_user_id": "edca7720-41f2-4a2d-a179-74bbf1a87ff7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-24T08:52:30.1012705+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-07-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-24T08:52:30.1012705+00:00",
"date_last_job": "2026-07-24T08:52:30.1012705+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-24T08:52:30.1012705+00:00",
"modified_dateutc": "2026-07-24T08:52:30.1012705+00:00",
"is_mobile_installation": true
},
"job_type_id": "106858b0-5e44-404b-ba2e-74c2a89b91d2",
"job_type_code": "sample string 7",
"job_type": {
"id": "6bf5c188-4a49-4563-b9ed-9f01ee2ea237",
"name": "sample string 2",
"sales_organization_id": "ee4e7ea4-f863-46e1-8ac0-e2252a05773f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-24T08:52:30.1012705+00:00",
"code": "sample string 7"
},
"job_priority_id": "7319c985-192e-4876-ac5e-0927f78c442b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d7edaa09-0151-435a-85b9-1e1ef8ce92d3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "050cb893-da27-4179-a147-8bcae83cfe2a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e60d8dc9-ed46-472c-917f-53f8bc42679c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a55f29eb-22a3-4386-9ebf-8a3f3e4fc1f8",
"db_currency_id": "5b2d8d4e-a4dd-4110-a7cd-1fb9dcc878b4",
"db_language_id": "aa18d671-dcaa-4c10-a7c1-48da72676833",
"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-07-24T08:52:30.1012705+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-24T08:52:30.1012705+00:00"
},
"job_status_id": "802f128f-80a9-4318-8c07-07bb0bd039da",
"job_status_code": "sample string 11",
"db_address_id": "d3e06b9f-a87f-4c3e-b792-9cf88130d9e7",
"contact_id": "21b54b44-da79-4589-9e04-319e91ec1c80",
"requested_by_company_id": "f31ba409-ac95-4659-a391-e3be6d5eb804",
"requested_by_contact_id": "700d217a-373c-40a5-ae9f-8757b851983e",
"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-07-24T08:52:30.1012705+00:00",
"due_date": "2026-07-24T08:52:30.1012705+00:00",
"date_create": "2026-07-24T08:52:30.1012705+00:00",
"date_update": "2026-07-24T08:52:30.1012705+00:00",
"date_closed": "2026-07-24T08:52:30.1012705+00:00",
"suggested_user_id": "94a124ff-00ef-497b-b119-948c57b507b0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "bcc2067a-f4f9-41ff-8c5f-f59928889a53",
"db_language_id": "23df6266-ea9e-46ab-a246-7b00f2e2d94a",
"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-07-24T08:52:30.1012705+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5038e590-64c0-4bf5-85d8-17ab8722fac1",
"sales_organization": {
"id": "e60d8dc9-ed46-472c-917f-53f8bc42679c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a55f29eb-22a3-4386-9ebf-8a3f3e4fc1f8",
"db_currency_id": "5b2d8d4e-a4dd-4110-a7cd-1fb9dcc878b4",
"db_language_id": "aa18d671-dcaa-4c10-a7c1-48da72676833",
"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-07-24T08:52:30.1012705+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "644572b8-e7b5-4448-8a38-7bab831c359c",
"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": "75d7590d-e60d-41cd-b747-8c8a59cfc344",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-24T08:52:30.1012705+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e2f4a459-1df3-41f0-93af-b25c49beac47"
},
"suggested_date_start": "2026-07-24T08:52:30.1012705+00:00",
"skill_id": "34117df6-0bda-4039-bbd1-e27efd6f42ef",
"skill_code": "sample string 32",
"skill": {
"id": "bdc741b6-5a9d-43d6-9dbd-592fa19cb296",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "28c4a1d9-0b37-4413-ac11-3db05abb9f4f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e60d8dc9-ed46-472c-917f-53f8bc42679c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a55f29eb-22a3-4386-9ebf-8a3f3e4fc1f8",
"db_currency_id": "5b2d8d4e-a4dd-4110-a7cd-1fb9dcc878b4",
"db_language_id": "aa18d671-dcaa-4c10-a7c1-48da72676833",
"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-07-24T08:52:30.1012705+00:00"
},
"modified_dateutc": "2026-07-24T08:52:30.1012705+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7025a2b3-82d1-4414-a16f-9d627efe74d9",
"date_reported_by_company": "2026-07-24T08:52:30.1012705+00:00",
"id2": 36,
"company_id": "31f2cd02-b575-4e7b-a6e5-984df0e735c1",
"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": "98d28c18-54b4-41d1-8737-affd286f2411",
"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-07-24T08:52:30.1012705+00:00"
},
"work_instruction_details_id": "664b5482-d883-49a1-bda2-17b65d31474c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1b5e35de-738f-4b62-b295-e1169b78a9e5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a257a7ba-6f01-4b1f-bc28-dbae2ce078d0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-24T08:52:30.1012705+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": "e27bcb19-b922-48c7-86ed-403b7750e9f4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-24T08:52:30.1012705+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.