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": "2e4a6742-76d0-45af-a959-14723ec29be2",
"jobs_id": "7b099d9b-513d-4850-9d8b-18f0bec6e70c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d77ee7f9-ee7c-4493-aa8b-98e1ef0a6602",
"_parent_id": "e5496337-b613-462c-9094-6d9c0841d94e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c30a5d39-3d60-4f09-9aa3-ce7e9064a5ee",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b2a1f37f-c840-49a2-8e89-23cdb48b6f2f",
"_parent_id": "8e894fec-95ad-4a4f-a555-287d655bb22e",
"root_parent_id": "a56b5966-179b-4500-9550-490377cd17f8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "72c4d079-db3d-4603-9c8e-008f5d1a6508",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "987b60ca-9591-44f8-a4f2-6ee8d7b7a878",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f96617bd-25b9-4efc-9588-cffd0dc3cc2d",
"_parent_code": "sample string 6",
"sales_organization_id": "6cb88c4b-1347-4ee8-b773-89ebc4f4f2d8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a65f243b-a013-4fd6-a79e-4a23fde7b76c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3cfc1fbe-fad4-48b3-ac15-90bef5d1b0e2",
"db_currency_id": "033bd2ee-f825-4755-a42e-7bb29526e025",
"db_language_id": "ff257db0-f1e4-4596-b42b-deea0d02dff4",
"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-11T22:14:03.8526933+00:00"
},
"modified_dateutc": "2026-09-11T22:14:03.8526933+00:00"
},
"equipment_model_id": "ecdb1e3f-bbbb-4e8d-aa52-65c5971929b5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c5a9992d-d1dd-4e6a-9977-27762fc72a6a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "577137ac-d60e-42cd-a24b-67dc5b713e5e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7fb976e4-fb3e-45c5-8866-ca5619c4c8e4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1fa86386-55a9-4c20-818a-e764e1195370",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a65f243b-a013-4fd6-a79e-4a23fde7b76c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3cfc1fbe-fad4-48b3-ac15-90bef5d1b0e2",
"db_currency_id": "033bd2ee-f825-4755-a42e-7bb29526e025",
"db_language_id": "ff257db0-f1e4-4596-b42b-deea0d02dff4",
"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-11T22:14:03.8526933+00:00"
},
"modified_dateutc": "2026-09-11T22:14:03.8526933+00:00"
},
"equipment_family_id": "73cbd4e5-46da-4495-b1af-6424f8177117",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "987b60ca-9591-44f8-a4f2-6ee8d7b7a878",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f96617bd-25b9-4efc-9588-cffd0dc3cc2d",
"_parent_code": "sample string 6",
"sales_organization_id": "6cb88c4b-1347-4ee8-b773-89ebc4f4f2d8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a65f243b-a013-4fd6-a79e-4a23fde7b76c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3cfc1fbe-fad4-48b3-ac15-90bef5d1b0e2",
"db_currency_id": "033bd2ee-f825-4755-a42e-7bb29526e025",
"db_language_id": "ff257db0-f1e4-4596-b42b-deea0d02dff4",
"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-11T22:14:03.8526933+00:00"
},
"modified_dateutc": "2026-09-11T22:14:03.8526933+00:00"
},
"date_in_production_since": "2026-09-11T22:14:03.8526933+00:00",
"date_out_of_production_since": "2026-09-11T22:14:03.8526933+00:00",
"date_end_support": "2026-09-11T22:14:03.8526933+00:00",
"sales_organization_id": "a90b1a3e-237e-4134-a729-ee49a2440380",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a65f243b-a013-4fd6-a79e-4a23fde7b76c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3cfc1fbe-fad4-48b3-ac15-90bef5d1b0e2",
"db_currency_id": "033bd2ee-f825-4755-a42e-7bb29526e025",
"db_language_id": "ff257db0-f1e4-4596-b42b-deea0d02dff4",
"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-11T22:14:03.8526933+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-11T22:14:03.8526933+00:00"
},
"project_status_id": "1cd04fd5-f1d2-46c6-b765-b647748a5d8a",
"project_status_code": "sample string 10",
"project_status": {
"id": "f18b10c0-771c-409d-8ceb-c306f09662f2",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "33af5034-ef22-4eb7-8cd4-3a22daaa5b07",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a65f243b-a013-4fd6-a79e-4a23fde7b76c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3cfc1fbe-fad4-48b3-ac15-90bef5d1b0e2",
"db_currency_id": "033bd2ee-f825-4755-a42e-7bb29526e025",
"db_language_id": "ff257db0-f1e4-4596-b42b-deea0d02dff4",
"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-11T22:14:03.8526933+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-11T22:14:03.8526933+00:00"
},
"company_id": "cde7be99-f5a3-434b-8074-7581d863a81c",
"company_code": "sample string 12",
"db_address_id": "4dd8a637-4eaa-4f31-8593-4db54bb4f771",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ab1bcd5c-6c3b-47c7-9931-47e93bf89a26",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e6f385ec-8484-44af-83b7-a6d7bac3988a",
"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-11T22:14:03.8526933+00:00",
"date_create": "2026-09-11T22:14:03.8526933+00:00",
"date_update": "2026-09-11T22:14:03.8526933+00:00",
"updated_by_user_id": "50fdbeb2-e3a2-4912-bf7d-36f57d800e57",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-11T22:14:03.8526933+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-11T22:14:03.8526933+00:00",
"date_last_job": "2026-09-11T22:14:03.8526933+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-11T22:14:03.8526933+00:00",
"modified_dateutc": "2026-09-11T22:14:03.8526933+00:00",
"is_mobile_installation": true
},
"job_type_id": "c81d6522-c0f7-4812-9e3f-85f1c1b5089c",
"job_type_code": "sample string 7",
"job_type": {
"id": "dc9da739-3e1a-4507-aeb9-f082e7fe3cfc",
"name": "sample string 2",
"sales_organization_id": "468caf99-17d0-45b9-bbff-076cd8ea0a58",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-11T22:14:03.8526933+00:00",
"code": "sample string 7"
},
"job_priority_id": "fa605e34-af02-40de-b8c0-2fae657ecf41",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a9054226-f946-4505-8785-efa6b8680391",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "babadb01-4613-442b-8108-9f683669840c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a65f243b-a013-4fd6-a79e-4a23fde7b76c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3cfc1fbe-fad4-48b3-ac15-90bef5d1b0e2",
"db_currency_id": "033bd2ee-f825-4755-a42e-7bb29526e025",
"db_language_id": "ff257db0-f1e4-4596-b42b-deea0d02dff4",
"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-11T22:14:03.8526933+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-11T22:14:03.8526933+00:00"
},
"job_status_id": "d9e5cd69-8bb5-4eef-a92f-00a392a12668",
"job_status_code": "sample string 11",
"db_address_id": "c4ec8475-6a6d-4aaf-9ac9-c1ef00610b33",
"contact_id": "8d391dec-64dd-4bc5-90b1-f0899100e615",
"requested_by_company_id": "83a8f527-7769-466e-92d7-93bd40e8e2da",
"requested_by_contact_id": "96d0ca05-45c6-49cf-be69-6b42d2eb3be1",
"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-11T22:14:03.8526933+00:00",
"due_date": "2026-09-11T22:14:03.8526933+00:00",
"date_create": "2026-09-11T22:14:03.8526933+00:00",
"date_update": "2026-09-11T22:14:03.8526933+00:00",
"date_closed": "2026-09-11T22:14:03.8526933+00:00",
"suggested_user_id": "37568bb4-ad10-4767-9db7-3bd1e82eba43",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f5ba4b4a-2d42-4f99-a106-33d1975c5ebc",
"db_language_id": "78f0ec96-6ad7-4f63-8e1a-c652732e3b56",
"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-11T22:14:03.8526933+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "326f642e-7d94-4e98-bda0-c39345a764db",
"sales_organization": {
"id": "a65f243b-a013-4fd6-a79e-4a23fde7b76c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3cfc1fbe-fad4-48b3-ac15-90bef5d1b0e2",
"db_currency_id": "033bd2ee-f825-4755-a42e-7bb29526e025",
"db_language_id": "ff257db0-f1e4-4596-b42b-deea0d02dff4",
"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-11T22:14:03.8526933+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5199fc2a-e34f-442c-afed-bc7d68b63900",
"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": "148f0f0d-cb1c-43f8-8d29-a36d6a173174",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-11T22:14:03.8526933+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "304bed7d-077b-414b-9cf4-c9ccb6b342c0"
},
"suggested_date_start": "2026-09-11T22:14:03.8526933+00:00",
"skill_id": "ba0afa26-40bf-4343-bf56-e3c8e298211c",
"skill_code": "sample string 32",
"skill": {
"id": "68edb553-fce0-47f0-bcad-5c114298d2cd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "cdcd0853-3c26-442c-aa66-7e943dd5f007",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a65f243b-a013-4fd6-a79e-4a23fde7b76c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3cfc1fbe-fad4-48b3-ac15-90bef5d1b0e2",
"db_currency_id": "033bd2ee-f825-4755-a42e-7bb29526e025",
"db_language_id": "ff257db0-f1e4-4596-b42b-deea0d02dff4",
"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-11T22:14:03.8526933+00:00"
},
"modified_dateutc": "2026-09-11T22:14:03.8526933+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7b26365b-8c40-4bf6-8586-a6b3563499e0",
"date_reported_by_company": "2026-09-11T22:14:03.8526933+00:00",
"id2": 36,
"company_id": "42554f44-6157-4988-b7fa-1e38215e9248",
"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": "594e715a-9c87-4420-bda8-28e3797dc019",
"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-11T22:14:03.8526933+00:00"
},
"work_instruction_details_id": "adac63fa-dc5b-4c3a-ad02-abdb079213f4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "81b5bb82-086d-4469-807d-2c5cc56b9509",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d631a986-db49-4129-b418-07ec4850ec24",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-11T22:14:03.8526933+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": "ef2ffd71-c900-405d-a0dd-a8b945e9d2b0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-11T22:14:03.8526933+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.