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": "fff1b401-ded2-401f-9a15-802ddf8384a9",
"jobs_id": "b2ddbb53-f23d-4c4f-8194-9a74b05c5cbe",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "92368267-6403-40ce-aa16-734c1f70d368",
"_parent_id": "615ddf25-ff0a-4f9b-aa42-63269a7e4a3b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "acbe4e30-f6d9-4863-a221-53a2970a6656",
"project_reference_back_office": "sample string 5",
"project": {
"id": "363c8464-4221-4b4a-a9ce-4c20496281f2",
"_parent_id": "aacabc3f-550b-4e7c-8fa1-c827082b683d",
"root_parent_id": "95324fa3-c44c-4337-99a2-1a0221d8c19f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "da215b1d-7b21-4697-beac-aa4c07adb131",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7d5371f4-db90-4f36-a1e9-a53f2fc78bbe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "414f372f-3f1c-4086-b18b-a0c1f09f54fd",
"_parent_code": "sample string 6",
"sales_organization_id": "a519c4cb-a47f-493a-9204-4646dc0a53d4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "aa3dfa39-16c2-481f-9be1-3c10fa12e61f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1ab1913e-bb67-4df3-bdea-05f8d2b89d43",
"db_currency_id": "fe26338b-caa7-4699-865e-faea36c24bd2",
"db_language_id": "5166eab3-f3c4-4505-bdc0-f459d8bd2147",
"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-01-29T23:16:14.9862091+00:00"
},
"modified_dateutc": "2026-01-29T23:16:14.9862091+00:00"
},
"equipment_model_id": "b4f166f4-1ed4-4fd3-8206-7361b6e4d537",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d50ebb8d-e113-449f-8281-cca294eb15b8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "479c7c95-871a-4e4e-ad24-18f67eed1c22",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "57ecdf67-fe5b-4124-a6dd-03e15a520932",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "16bc34ea-d2ce-4c71-bbbc-533cb83fdd63",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "aa3dfa39-16c2-481f-9be1-3c10fa12e61f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1ab1913e-bb67-4df3-bdea-05f8d2b89d43",
"db_currency_id": "fe26338b-caa7-4699-865e-faea36c24bd2",
"db_language_id": "5166eab3-f3c4-4505-bdc0-f459d8bd2147",
"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-01-29T23:16:14.9862091+00:00"
},
"modified_dateutc": "2026-01-29T23:16:14.9862091+00:00"
},
"equipment_family_id": "4d51e6d3-cd15-4785-909a-6a66a306cd5d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7d5371f4-db90-4f36-a1e9-a53f2fc78bbe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "414f372f-3f1c-4086-b18b-a0c1f09f54fd",
"_parent_code": "sample string 6",
"sales_organization_id": "a519c4cb-a47f-493a-9204-4646dc0a53d4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "aa3dfa39-16c2-481f-9be1-3c10fa12e61f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1ab1913e-bb67-4df3-bdea-05f8d2b89d43",
"db_currency_id": "fe26338b-caa7-4699-865e-faea36c24bd2",
"db_language_id": "5166eab3-f3c4-4505-bdc0-f459d8bd2147",
"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-01-29T23:16:14.9862091+00:00"
},
"modified_dateutc": "2026-01-29T23:16:14.9862091+00:00"
},
"date_in_production_since": "2026-01-29T23:16:14.9862091+00:00",
"date_out_of_production_since": "2026-01-29T23:16:14.9862091+00:00",
"date_end_support": "2026-01-29T23:16:14.9862091+00:00",
"sales_organization_id": "8c189f15-d21a-4f6c-9540-2a144926ed53",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "aa3dfa39-16c2-481f-9be1-3c10fa12e61f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1ab1913e-bb67-4df3-bdea-05f8d2b89d43",
"db_currency_id": "fe26338b-caa7-4699-865e-faea36c24bd2",
"db_language_id": "5166eab3-f3c4-4505-bdc0-f459d8bd2147",
"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-01-29T23:16:14.9862091+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-01-29T23:16:14.9862091+00:00"
},
"project_status_id": "7f032ba5-9804-46c3-8b95-e0c361e82e34",
"project_status_code": "sample string 10",
"project_status": {
"id": "a8ae0876-2a86-40af-ae02-941f0791bf25",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "dea64b04-fa9b-4aff-8810-9302d167b959",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aa3dfa39-16c2-481f-9be1-3c10fa12e61f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1ab1913e-bb67-4df3-bdea-05f8d2b89d43",
"db_currency_id": "fe26338b-caa7-4699-865e-faea36c24bd2",
"db_language_id": "5166eab3-f3c4-4505-bdc0-f459d8bd2147",
"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-01-29T23:16:14.9862091+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-29T23:16:14.9862091+00:00"
},
"company_id": "5763f91c-046c-4bb3-9309-94baa7709443",
"company_code": "sample string 12",
"db_address_id": "c9a1f29a-e7fc-4d34-8c55-549303eee6f0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3be737f1-0510-4340-b7a2-2820b4a527ef",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e087104f-b3ef-488b-b39b-37e0eb67f504",
"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-01-29T23:16:14.9862091+00:00",
"date_create": "2026-01-29T23:16:14.9862091+00:00",
"date_update": "2026-01-29T23:16:14.9862091+00:00",
"updated_by_user_id": "78c8b4ee-a1c3-4559-b3ba-bc977bee99a9",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-29T23:16:14.9862091+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-01-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-29T23:16:14.9862091+00:00",
"date_last_job": "2026-01-29T23:16:14.9862091+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-29T23:16:14.9862091+00:00",
"modified_dateutc": "2026-01-29T23:16:14.9862091+00:00",
"is_mobile_installation": true
},
"job_type_id": "87221519-4822-4856-b276-ca5b599a0506",
"job_type_code": "sample string 7",
"job_type": {
"id": "ea9ad22e-4812-4648-b49c-a46a5e45ef79",
"name": "sample string 2",
"sales_organization_id": "899331bc-f79a-48e6-8c6b-2c029d7c14df",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-29T23:16:14.9862091+00:00",
"code": "sample string 7"
},
"job_priority_id": "c7a3b4f3-ed91-4712-b533-6cf8f339a8e1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "38353cca-56d7-40de-97a7-889b182df407",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "59873591-c011-4413-951b-a1e981def51b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aa3dfa39-16c2-481f-9be1-3c10fa12e61f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1ab1913e-bb67-4df3-bdea-05f8d2b89d43",
"db_currency_id": "fe26338b-caa7-4699-865e-faea36c24bd2",
"db_language_id": "5166eab3-f3c4-4505-bdc0-f459d8bd2147",
"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-01-29T23:16:14.9862091+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-29T23:16:14.9862091+00:00"
},
"job_status_id": "13161056-08b6-4736-b77c-85b224b47226",
"job_status_code": "sample string 11",
"db_address_id": "6eb3d65a-069f-4c05-b734-362fbc8f974a",
"contact_id": "be902819-9aa5-4b76-9f95-bf07e6e5589b",
"requested_by_company_id": "fabb612e-6ff2-4512-9c73-41096e1a753c",
"requested_by_contact_id": "760506ec-3ee1-49f7-8e9f-268e1a8950bb",
"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-01-29T23:16:14.9862091+00:00",
"due_date": "2026-01-29T23:16:14.9862091+00:00",
"date_create": "2026-01-29T23:16:14.9862091+00:00",
"date_update": "2026-01-29T23:16:14.9862091+00:00",
"date_closed": "2026-01-29T23:16:14.9862091+00:00",
"suggested_user_id": "60d0b1ae-eddd-4797-80d0-62f55563f1f2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f21de3c6-862e-4038-97c7-291d7b24f009",
"db_language_id": "4ede0214-3e5c-4931-9feb-ccd982b5ba02",
"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-01-29T23:16:14.9862091+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5013becb-5300-4f86-a968-4e455c151ece",
"sales_organization": {
"id": "aa3dfa39-16c2-481f-9be1-3c10fa12e61f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1ab1913e-bb67-4df3-bdea-05f8d2b89d43",
"db_currency_id": "fe26338b-caa7-4699-865e-faea36c24bd2",
"db_language_id": "5166eab3-f3c4-4505-bdc0-f459d8bd2147",
"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-01-29T23:16:14.9862091+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "19c6b2e1-bff1-4b23-84cf-de37e0441d83",
"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": "bc0f0d5f-f01e-4377-a65b-1a01978e4a98",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-29T23:16:14.9862091+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "eacb550d-d857-42d7-bc65-cf6044afd0a4"
},
"suggested_date_start": "2026-01-29T23:16:14.9862091+00:00",
"skill_id": "9a18d8fa-d357-4079-9e7e-57d9d3de5f22",
"skill_code": "sample string 32",
"skill": {
"id": "d235649f-7f34-418b-acc4-2c605876624d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4301702d-6b3d-402d-a422-732b104bd99e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aa3dfa39-16c2-481f-9be1-3c10fa12e61f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1ab1913e-bb67-4df3-bdea-05f8d2b89d43",
"db_currency_id": "fe26338b-caa7-4699-865e-faea36c24bd2",
"db_language_id": "5166eab3-f3c4-4505-bdc0-f459d8bd2147",
"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-01-29T23:16:14.9862091+00:00"
},
"modified_dateutc": "2026-01-29T23:16:14.9862091+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "faac0481-897c-4fee-999d-845dc2c75c72",
"date_reported_by_company": "2026-01-29T23:16:14.9862091+00:00",
"id2": 36,
"company_id": "f8226cca-46cb-4861-b14a-6cf06bef6e47",
"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": "97841549-6edd-4056-9453-14e579542a12",
"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-01-29T23:16:14.9862091+00:00"
},
"work_instruction_details_id": "39cd1bb2-15bc-408b-98c3-ce66c4946adc",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f3377250-683e-47ec-904c-991e47d0490b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "73b74dc6-22e2-4258-96cc-b672b6fc0d7a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-29T23:16:14.9862091+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": "818dee05-3815-434b-b47f-aa281e1c46c9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-29T23:16:14.9862091+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.