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": "4ec15f2b-bc95-4a41-8c99-018dcef014ab",
"jobs_id": "d6e5910c-d8dc-40a8-9152-2f6306288934",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "791f9928-bfa6-4ead-aca0-3664290902cf",
"_parent_id": "89e84a81-595a-410e-9a12-2b9cee0c55d4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0ac68ab1-02f5-4ca3-8c44-acd571507fd3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7a73ecd9-69e8-4f6b-994d-1dea0a9dd582",
"_parent_id": "df707938-c5cd-4a4e-9fc0-abb7cae2df44",
"root_parent_id": "1ce3706e-b4de-40ab-8f99-e8c81835b12f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "15e300c3-457b-4a11-a3fe-1c1c07921e45",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c34f9343-2bc8-4ef9-b2ca-e6d0456655a2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5870386a-9798-4e4d-a65e-78f6fc4d71bb",
"_parent_code": "sample string 6",
"sales_organization_id": "d62c2039-0a10-4fe5-85f7-0090432e7b58",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "73f964d4-c672-4648-9680-7f9cbbb6adf3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f274eb1a-873f-4c36-8d02-98fdf9625ca4",
"db_currency_id": "df163527-f326-49e2-afda-14922f353fd2",
"db_language_id": "21150e27-bce0-4b6c-a439-e6c4dc34b96b",
"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-13T16:04:13.3344106+00:00"
},
"modified_dateutc": "2026-07-13T16:04:13.3344106+00:00"
},
"equipment_model_id": "b2848315-ec66-402f-a1b6-d1220958ea5d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "15a55be0-20c0-431d-8350-e049252a22a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "27a2c8b3-32c6-4527-b68f-d412504dd0f1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ae903b79-2a32-4248-ad85-3507bf3eb738",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "bdd20f3d-5033-47a8-a322-3b80ef648e05",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "73f964d4-c672-4648-9680-7f9cbbb6adf3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f274eb1a-873f-4c36-8d02-98fdf9625ca4",
"db_currency_id": "df163527-f326-49e2-afda-14922f353fd2",
"db_language_id": "21150e27-bce0-4b6c-a439-e6c4dc34b96b",
"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-13T16:04:13.3344106+00:00"
},
"modified_dateutc": "2026-07-13T16:04:13.3344106+00:00"
},
"equipment_family_id": "92b11e5e-e515-483e-be16-bc7152991cde",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c34f9343-2bc8-4ef9-b2ca-e6d0456655a2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5870386a-9798-4e4d-a65e-78f6fc4d71bb",
"_parent_code": "sample string 6",
"sales_organization_id": "d62c2039-0a10-4fe5-85f7-0090432e7b58",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "73f964d4-c672-4648-9680-7f9cbbb6adf3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f274eb1a-873f-4c36-8d02-98fdf9625ca4",
"db_currency_id": "df163527-f326-49e2-afda-14922f353fd2",
"db_language_id": "21150e27-bce0-4b6c-a439-e6c4dc34b96b",
"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-13T16:04:13.3344106+00:00"
},
"modified_dateutc": "2026-07-13T16:04:13.3344106+00:00"
},
"date_in_production_since": "2026-07-13T16:04:13.3344106+00:00",
"date_out_of_production_since": "2026-07-13T16:04:13.3344106+00:00",
"date_end_support": "2026-07-13T16:04:13.3344106+00:00",
"sales_organization_id": "73e046a7-ba1c-49fd-9433-c9f07fd0c737",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "73f964d4-c672-4648-9680-7f9cbbb6adf3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f274eb1a-873f-4c36-8d02-98fdf9625ca4",
"db_currency_id": "df163527-f326-49e2-afda-14922f353fd2",
"db_language_id": "21150e27-bce0-4b6c-a439-e6c4dc34b96b",
"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-13T16:04:13.3344106+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-13T16:04:13.3344106+00:00"
},
"project_status_id": "6baf9157-e2c7-4a9f-b2c0-c657cd5bcf92",
"project_status_code": "sample string 10",
"project_status": {
"id": "f1208cbe-1e3b-4123-affe-de96351f55a8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1e642f58-db8f-4e84-b6fb-c50543a32675",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "73f964d4-c672-4648-9680-7f9cbbb6adf3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f274eb1a-873f-4c36-8d02-98fdf9625ca4",
"db_currency_id": "df163527-f326-49e2-afda-14922f353fd2",
"db_language_id": "21150e27-bce0-4b6c-a439-e6c4dc34b96b",
"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-13T16:04:13.3344106+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-13T16:04:13.3344106+00:00"
},
"company_id": "e7acc733-2f1e-492b-8564-97bf924457fd",
"company_code": "sample string 12",
"db_address_id": "18b6a384-1984-43b4-a0b9-29216fa6eb79",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8cb99d6d-146b-4d75-b143-1ebde41d5394",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a9eb4ec7-a60b-4593-bdbd-76eed348c5dd",
"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-13T16:04:13.3344106+00:00",
"date_create": "2026-07-13T16:04:13.3344106+00:00",
"date_update": "2026-07-13T16:04:13.3344106+00:00",
"updated_by_user_id": "81034924-406a-4caa-bf4f-48e7e2f0dd96",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-13T16:04:13.3344106+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-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-13T16:04:13.3344106+00:00",
"date_last_job": "2026-07-13T16:04:13.3344106+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-13T16:04:13.3344106+00:00",
"modified_dateutc": "2026-07-13T16:04:13.3344106+00:00",
"is_mobile_installation": true
},
"job_type_id": "85970dce-7a55-4bc0-abcc-5aab04379cff",
"job_type_code": "sample string 7",
"job_type": {
"id": "a4d51406-f755-48ba-a43e-85bfeb98a1c0",
"name": "sample string 2",
"sales_organization_id": "7c8b4111-e339-4ac6-8683-2aa4b8bcb3b0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-13T16:04:13.3344106+00:00",
"code": "sample string 7"
},
"job_priority_id": "320e9d17-1c37-41ec-9ffe-3a34ac082f2a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9a2f5b56-121e-4284-8ae3-dcfd777ea3e3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8adf179b-1253-4673-bed5-519df11429ac",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "73f964d4-c672-4648-9680-7f9cbbb6adf3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f274eb1a-873f-4c36-8d02-98fdf9625ca4",
"db_currency_id": "df163527-f326-49e2-afda-14922f353fd2",
"db_language_id": "21150e27-bce0-4b6c-a439-e6c4dc34b96b",
"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-13T16:04:13.3344106+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-13T16:04:13.3344106+00:00"
},
"job_status_id": "658d0fe7-68ff-4b50-97be-d9930f84520a",
"job_status_code": "sample string 11",
"db_address_id": "5071da9a-32a2-4d97-a65b-dabf40e0638b",
"contact_id": "d193450a-365e-4be5-ae4c-9bdb0135ac93",
"requested_by_company_id": "f2e32fbc-4354-4613-b6a5-0042949de306",
"requested_by_contact_id": "7b341bcf-2ae9-4b67-9813-62ec074b9df9",
"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-13T16:04:13.3344106+00:00",
"due_date": "2026-07-13T16:04:13.3344106+00:00",
"date_create": "2026-07-13T16:04:13.3344106+00:00",
"date_update": "2026-07-13T16:04:13.3344106+00:00",
"date_closed": "2026-07-13T16:04:13.3344106+00:00",
"suggested_user_id": "de2bc604-c201-47d9-8c27-ef53197c383c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "67558533-976b-4339-aaa5-cbd275108bed",
"db_language_id": "95179661-2010-4880-a36d-dcc1079aee38",
"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-13T16:04:13.3344106+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1ce7b66e-6919-48f2-8680-da505b46a7d4",
"sales_organization": {
"id": "73f964d4-c672-4648-9680-7f9cbbb6adf3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f274eb1a-873f-4c36-8d02-98fdf9625ca4",
"db_currency_id": "df163527-f326-49e2-afda-14922f353fd2",
"db_language_id": "21150e27-bce0-4b6c-a439-e6c4dc34b96b",
"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-13T16:04:13.3344106+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "057fa165-eae6-491f-aef9-8e7483512ef9",
"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": "6101738a-4996-447b-8f31-8cbd433d7115",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-13T16:04:13.3344106+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "135f065a-355d-452e-aa36-797dd80ffe91"
},
"suggested_date_start": "2026-07-13T16:04:13.3344106+00:00",
"skill_id": "afc6c5c0-2121-491a-b53e-5b79668ddca9",
"skill_code": "sample string 32",
"skill": {
"id": "b674fca3-2f9c-4778-ab5a-59b8b9a94a2b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "60a36704-e5f4-476f-bb6c-42d0c8a5516c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "73f964d4-c672-4648-9680-7f9cbbb6adf3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f274eb1a-873f-4c36-8d02-98fdf9625ca4",
"db_currency_id": "df163527-f326-49e2-afda-14922f353fd2",
"db_language_id": "21150e27-bce0-4b6c-a439-e6c4dc34b96b",
"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-13T16:04:13.3344106+00:00"
},
"modified_dateutc": "2026-07-13T16:04:13.3344106+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "33a05c74-0a84-4b34-a8e9-1fdac0ceaa54",
"date_reported_by_company": "2026-07-13T16:04:13.3344106+00:00",
"id2": 36,
"company_id": "19ca4874-3119-4683-96ed-dad38661b06c",
"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": "bf47470f-f601-4e2a-bca8-4816222cb597",
"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-13T16:04:13.3344106+00:00"
},
"work_instruction_details_id": "56227068-84b4-45e9-8c67-dca419675576",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ea79049a-ec3a-496b-ae6b-f8ab1b7fe0cc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c7cc06b3-f460-4c76-9799-6633cb6a82af",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-13T16:04:13.3344106+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": "86562b35-77aa-49ff-aa79-a195aebdb424",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-13T16:04:13.3344106+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.