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": "a82fa360-dab4-46cb-a256-2fda57f6cf4e",
"jobs_id": "2bfdc8fd-b4dd-436f-b1b3-4a5bf26df8fc",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e3f87940-126e-44a3-92a2-b5e18be01213",
"_parent_id": "34775300-7bcb-4d54-bb9b-b36aca3742a9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "675b8410-7b00-498e-921d-3b7e23add4c0",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b26ea846-14ec-47e4-885a-f1e23d862049",
"_parent_id": "87a9ea6c-36f0-4081-8b59-6855f48da888",
"root_parent_id": "e7edaa30-4c65-4d13-9905-da4fa71c22ed",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "af79d172-3e4b-4e83-9215-3def2a242b74",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7391f9f8-832e-4157-baea-c2f162ed806b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2290cfee-4e23-462b-b78e-e48bc1de8e6a",
"_parent_code": "sample string 6",
"sales_organization_id": "9058bd32-f774-4f80-b36e-97401d292bbc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "516fd5ea-28c5-4923-8375-cab66a517f39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87149b8e-564d-42b9-abbb-1587170b9539",
"db_currency_id": "b3b2aa00-aed9-41c5-934b-47a1bf4c0941",
"db_language_id": "88e2aa20-7b8f-4d36-a653-047e2711cadc",
"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": "2025-09-16T06:44:19.1345208+00:00"
},
"modified_dateutc": "2025-09-16T06:44:19.1345208+00:00"
},
"equipment_model_id": "e4586c07-f510-4570-bd40-39ac93a390cd",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8b71b3b3-8865-4a37-9760-2947e20b0e44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "671c4833-257d-4424-b960-d4bb297d301a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2075fe06-f5a7-4d90-b9ab-aa9bf151110a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9c3a4c41-da5c-413f-8cdf-a35956fca44a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "516fd5ea-28c5-4923-8375-cab66a517f39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87149b8e-564d-42b9-abbb-1587170b9539",
"db_currency_id": "b3b2aa00-aed9-41c5-934b-47a1bf4c0941",
"db_language_id": "88e2aa20-7b8f-4d36-a653-047e2711cadc",
"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": "2025-09-16T06:44:19.1345208+00:00"
},
"modified_dateutc": "2025-09-16T06:44:19.1345208+00:00"
},
"equipment_family_id": "e5d3a1e5-2de1-4dfb-96ea-c3ca569dcc31",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7391f9f8-832e-4157-baea-c2f162ed806b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2290cfee-4e23-462b-b78e-e48bc1de8e6a",
"_parent_code": "sample string 6",
"sales_organization_id": "9058bd32-f774-4f80-b36e-97401d292bbc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "516fd5ea-28c5-4923-8375-cab66a517f39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87149b8e-564d-42b9-abbb-1587170b9539",
"db_currency_id": "b3b2aa00-aed9-41c5-934b-47a1bf4c0941",
"db_language_id": "88e2aa20-7b8f-4d36-a653-047e2711cadc",
"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": "2025-09-16T06:44:19.1345208+00:00"
},
"modified_dateutc": "2025-09-16T06:44:19.1345208+00:00"
},
"date_in_production_since": "2025-09-16T06:44:19.1345208+00:00",
"date_out_of_production_since": "2025-09-16T06:44:19.1345208+00:00",
"date_end_support": "2025-09-16T06:44:19.1345208+00:00",
"sales_organization_id": "86495ab2-d3fe-41cb-819a-9a3c055e8ad6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "516fd5ea-28c5-4923-8375-cab66a517f39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87149b8e-564d-42b9-abbb-1587170b9539",
"db_currency_id": "b3b2aa00-aed9-41c5-934b-47a1bf4c0941",
"db_language_id": "88e2aa20-7b8f-4d36-a653-047e2711cadc",
"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": "2025-09-16T06:44:19.1345208+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": "2025-09-16T06:44:19.1345208+00:00"
},
"project_status_id": "cce53599-55d5-4535-8630-ef988b75f6de",
"project_status_code": "sample string 10",
"project_status": {
"id": "ba0613b1-940f-49e9-8748-06992a78ef4f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "40fa3be9-8ce8-449f-ab3f-4913d250e9e5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "516fd5ea-28c5-4923-8375-cab66a517f39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87149b8e-564d-42b9-abbb-1587170b9539",
"db_currency_id": "b3b2aa00-aed9-41c5-934b-47a1bf4c0941",
"db_language_id": "88e2aa20-7b8f-4d36-a653-047e2711cadc",
"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": "2025-09-16T06:44:19.1345208+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-16T06:44:19.1345208+00:00"
},
"company_id": "cc9b9ec9-2f58-4675-98c0-afe8259ecb20",
"company_code": "sample string 12",
"db_address_id": "db2dd577-d4ac-4dd6-970f-53228fcbde9d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6cba4900-be1e-4919-bd98-d62dab969378",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "da0d60cc-87e5-4458-8b56-61474950930d",
"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": "2025-09-16T06:44:19.1345208+00:00",
"date_create": "2025-09-16T06:44:19.1345208+00:00",
"date_update": "2025-09-16T06:44:19.1345208+00:00",
"updated_by_user_id": "67638919-8a7d-43f4-9639-2a75019da910",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-09-16T06:44:19.1345208+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": "2025-09-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-09-16T06:44:19.1345208+00:00",
"date_last_job": "2025-09-16T06:44:19.1345208+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-09-16T06:44:19.1345208+00:00",
"modified_dateutc": "2025-09-16T06:44:19.1345208+00:00",
"is_mobile_installation": true
},
"job_type_id": "032e4b7c-90b5-47be-9dc9-6e4ead50711f",
"job_type_code": "sample string 7",
"job_type": {
"id": "f2c08bfb-2436-486c-b6dd-90c7e4fe866a",
"name": "sample string 2",
"sales_organization_id": "ab303884-bfaf-4559-9de6-2f11fce75cc7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-09-16T06:44:19.1345208+00:00",
"code": "sample string 7"
},
"job_priority_id": "6b6d2669-adb1-4500-8dbf-653c1e6116b2",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8e3fe992-d72a-4301-a359-7ffae9654d06",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7f772f50-da27-4c1f-90fb-c8f025adc1fc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "516fd5ea-28c5-4923-8375-cab66a517f39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87149b8e-564d-42b9-abbb-1587170b9539",
"db_currency_id": "b3b2aa00-aed9-41c5-934b-47a1bf4c0941",
"db_language_id": "88e2aa20-7b8f-4d36-a653-047e2711cadc",
"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": "2025-09-16T06:44:19.1345208+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-16T06:44:19.1345208+00:00"
},
"job_status_id": "fd8e3fa8-03e8-44f0-9abf-d0fc0ac44f6f",
"job_status_code": "sample string 11",
"db_address_id": "c33c3b75-0596-41ee-9ec4-9a8ab26ef21a",
"contact_id": "c26027cf-7784-495a-95b6-acafe6746117",
"requested_by_company_id": "48c24857-73e8-4071-81e4-c9cce50968a5",
"requested_by_contact_id": "6e8e42c8-aaa5-4301-9db7-3e2497015df3",
"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": "2025-09-16T06:44:19.1345208+00:00",
"due_date": "2025-09-16T06:44:19.1345208+00:00",
"date_create": "2025-09-16T06:44:19.1345208+00:00",
"date_update": "2025-09-16T06:44:19.1345208+00:00",
"date_closed": "2025-09-16T06:44:19.1345208+00:00",
"suggested_user_id": "295d8161-c203-48de-a0bb-ab15ad792c99",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "bc7c06d9-53be-49da-b705-bbbe4841569f",
"db_language_id": "323913b1-b201-4635-af11-7e5adf6ef767",
"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": "2025-09-16T06:44:19.1345208+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "af15fa0c-d0bb-4fd2-8ecc-a660259836b1",
"sales_organization": {
"id": "516fd5ea-28c5-4923-8375-cab66a517f39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87149b8e-564d-42b9-abbb-1587170b9539",
"db_currency_id": "b3b2aa00-aed9-41c5-934b-47a1bf4c0941",
"db_language_id": "88e2aa20-7b8f-4d36-a653-047e2711cadc",
"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": "2025-09-16T06:44:19.1345208+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f71013c9-457f-4a89-988c-68c3495b9a46",
"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": "0131d5e3-9c18-4cfd-8bd6-a1965bdaaffb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-09-16T06:44:19.1345208+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7a62db3c-9a13-47d9-bad4-9b0d1e5c9aef"
},
"suggested_date_start": "2025-09-16T06:44:19.1345208+00:00",
"skill_id": "b2c53a29-0c7d-4360-85ca-983bce0675b6",
"skill_code": "sample string 32",
"skill": {
"id": "45d95987-39f8-4858-952c-5311acf030bf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4708e7cb-2d67-4931-9cb5-ca55e2289fd1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "516fd5ea-28c5-4923-8375-cab66a517f39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87149b8e-564d-42b9-abbb-1587170b9539",
"db_currency_id": "b3b2aa00-aed9-41c5-934b-47a1bf4c0941",
"db_language_id": "88e2aa20-7b8f-4d36-a653-047e2711cadc",
"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": "2025-09-16T06:44:19.1345208+00:00"
},
"modified_dateutc": "2025-09-16T06:44:19.1345208+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b6c20457-0fda-4eb7-8170-faad3cb1dcd2",
"date_reported_by_company": "2025-09-16T06:44:19.1345208+00:00",
"id2": 36,
"company_id": "16e25ce8-0b11-4ed2-911b-d42e5738cd6c",
"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": "067bb9cd-dd05-465c-bfa3-76cba7c106a8",
"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": "2025-09-16T06:44:19.1345208+00:00"
},
"work_instruction_details_id": "91a627fe-70e9-4524-bda0-1ac18c89fb66",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4e539a44-a86c-4653-993e-b9bd2a578890",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "41cd7272-0503-4717-b93a-3585f9152a15",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-09-16T06:44:19.1345208+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": "16416359-14d8-441c-8204-778cc902b096",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-09-16T06:44:19.1345208+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.