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": "e0ac80ca-da84-4b92-8c8a-3ae4c86665db",
"jobs_id": "777c1d63-2121-49a0-9b7b-94b259195353",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "847f021c-e903-4b7f-a77d-34eae1ccbae7",
"_parent_id": "df6d0154-be84-407e-b5b5-d4642166ff4b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ed491fd4-2579-4ad8-a1bd-a5ce5e4ee6ee",
"project_reference_back_office": "sample string 5",
"project": {
"id": "bdf08ee1-9f20-41ce-b3f5-0292562bd3f6",
"_parent_id": "9ddd8bc1-5bde-41ce-aa6e-0a464a77dbf5",
"root_parent_id": "def86044-fc17-4555-8d99-6f46e00e5cbd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a9b0d098-c760-49b0-b96b-8ab81612cb59",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4a44b692-f14c-4bcc-9b30-bd5c0f4e49da",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c2ef980e-4353-47d9-a1ea-02a1c620a067",
"_parent_code": "sample string 6",
"sales_organization_id": "f8f730ec-2ba3-4885-9a1c-abc77dcc214e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "38a11350-1dc8-43f8-99f1-81eaede7f595",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b0e33b6-423f-4a22-a83f-d90738c6b9ed",
"db_currency_id": "1ae7d751-2d02-45b3-af6e-e751e4ab7871",
"db_language_id": "2cdf45b6-7c74-47ae-b2fa-01fa4e8bb5f2",
"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-08T12:12:10.8506674+00:00"
},
"modified_dateutc": "2026-01-08T12:12:10.8506674+00:00"
},
"equipment_model_id": "3ba6355c-29f4-4f1b-b807-8a44fc532cd6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d256d483-1e71-4218-b082-72226824b0e7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "af142e7f-d3c0-4513-95b4-bab9091589ad",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4b912e79-e55b-4bf0-bcb5-0ca17de24049",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e831fc85-47a7-4219-93df-b1f718390255",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "38a11350-1dc8-43f8-99f1-81eaede7f595",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b0e33b6-423f-4a22-a83f-d90738c6b9ed",
"db_currency_id": "1ae7d751-2d02-45b3-af6e-e751e4ab7871",
"db_language_id": "2cdf45b6-7c74-47ae-b2fa-01fa4e8bb5f2",
"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-08T12:12:10.8506674+00:00"
},
"modified_dateutc": "2026-01-08T12:12:10.8506674+00:00"
},
"equipment_family_id": "f2d68983-5981-4b12-8719-c19aedbe58ab",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4a44b692-f14c-4bcc-9b30-bd5c0f4e49da",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c2ef980e-4353-47d9-a1ea-02a1c620a067",
"_parent_code": "sample string 6",
"sales_organization_id": "f8f730ec-2ba3-4885-9a1c-abc77dcc214e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "38a11350-1dc8-43f8-99f1-81eaede7f595",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b0e33b6-423f-4a22-a83f-d90738c6b9ed",
"db_currency_id": "1ae7d751-2d02-45b3-af6e-e751e4ab7871",
"db_language_id": "2cdf45b6-7c74-47ae-b2fa-01fa4e8bb5f2",
"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-08T12:12:10.8506674+00:00"
},
"modified_dateutc": "2026-01-08T12:12:10.8506674+00:00"
},
"date_in_production_since": "2026-01-08T12:12:10.8506674+00:00",
"date_out_of_production_since": "2026-01-08T12:12:10.8506674+00:00",
"date_end_support": "2026-01-08T12:12:10.8506674+00:00",
"sales_organization_id": "e8664d70-3114-4a24-8026-d1d1ed663b63",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "38a11350-1dc8-43f8-99f1-81eaede7f595",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b0e33b6-423f-4a22-a83f-d90738c6b9ed",
"db_currency_id": "1ae7d751-2d02-45b3-af6e-e751e4ab7871",
"db_language_id": "2cdf45b6-7c74-47ae-b2fa-01fa4e8bb5f2",
"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-08T12:12:10.8506674+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-08T12:12:10.8506674+00:00"
},
"project_status_id": "c7124317-d1e1-41c8-9d1f-c78d61cd2f05",
"project_status_code": "sample string 10",
"project_status": {
"id": "61921db6-2bb5-42c6-a7d2-91c1a47255d5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1570683e-3625-48ba-8ac1-560be5b3f466",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "38a11350-1dc8-43f8-99f1-81eaede7f595",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b0e33b6-423f-4a22-a83f-d90738c6b9ed",
"db_currency_id": "1ae7d751-2d02-45b3-af6e-e751e4ab7871",
"db_language_id": "2cdf45b6-7c74-47ae-b2fa-01fa4e8bb5f2",
"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-08T12:12:10.8506674+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-08T12:12:10.8506674+00:00"
},
"company_id": "242682f6-b729-41ec-9058-abca28c44a28",
"company_code": "sample string 12",
"db_address_id": "7d5ca279-4195-42fd-a450-4c22130f70f6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9dc03017-5ed8-4bd7-bde6-8b8d2fa1ce64",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2e082a41-c229-4513-89ef-be13e617fa98",
"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-08T12:12:10.8506674+00:00",
"date_create": "2026-01-08T12:12:10.8506674+00:00",
"date_update": "2026-01-08T12:12:10.8506674+00:00",
"updated_by_user_id": "34588c93-7573-4692-a3f9-8ae17be88809",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-08T12:12:10.8506674+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-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-08T12:12:10.8506674+00:00",
"date_last_job": "2026-01-08T12:12:10.8506674+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-08T12:12:10.8506674+00:00",
"modified_dateutc": "2026-01-08T12:12:10.8506674+00:00",
"is_mobile_installation": true
},
"job_type_id": "c83c3ddd-9422-400a-a5b6-3dd93e4af87c",
"job_type_code": "sample string 7",
"job_type": {
"id": "dd049d85-6868-4dfb-ac13-f034430791bc",
"name": "sample string 2",
"sales_organization_id": "4ea8ceab-e15e-48fe-92d6-21d397129779",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-08T12:12:10.8506674+00:00",
"code": "sample string 7"
},
"job_priority_id": "8af7eaba-d90b-4c3c-8d03-ec4b51f62b77",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "08af8426-5c8c-4e74-a174-e74cf17c807b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8ee722b3-3ade-43f8-9486-6d0d8fe67dbb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "38a11350-1dc8-43f8-99f1-81eaede7f595",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b0e33b6-423f-4a22-a83f-d90738c6b9ed",
"db_currency_id": "1ae7d751-2d02-45b3-af6e-e751e4ab7871",
"db_language_id": "2cdf45b6-7c74-47ae-b2fa-01fa4e8bb5f2",
"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-08T12:12:10.8506674+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-08T12:12:10.8506674+00:00"
},
"job_status_id": "1168cabc-115f-47ae-9514-e011131bcd4f",
"job_status_code": "sample string 11",
"db_address_id": "c96750e5-b410-4f00-bfd5-d2f8bcd1494d",
"contact_id": "1a0c32ab-0c13-40eb-80a8-b9ac73833744",
"requested_by_company_id": "4f689a01-32f0-4ed3-8b52-5728ae571e40",
"requested_by_contact_id": "db93632c-2a6c-4527-9303-429161a00bfc",
"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-08T12:12:10.8506674+00:00",
"due_date": "2026-01-08T12:12:10.8506674+00:00",
"date_create": "2026-01-08T12:12:10.8506674+00:00",
"date_update": "2026-01-08T12:12:10.8506674+00:00",
"date_closed": "2026-01-08T12:12:10.8506674+00:00",
"suggested_user_id": "fa3a68f7-e968-468d-880f-365e85415ece",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "59787b83-1852-4a00-a023-d68bd3896f69",
"db_language_id": "50d18ef6-fe71-413f-8011-d903f51cdf47",
"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-08T12:12:10.8506674+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "97a3f6f1-801d-4e98-8acd-c73e36395952",
"sales_organization": {
"id": "38a11350-1dc8-43f8-99f1-81eaede7f595",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b0e33b6-423f-4a22-a83f-d90738c6b9ed",
"db_currency_id": "1ae7d751-2d02-45b3-af6e-e751e4ab7871",
"db_language_id": "2cdf45b6-7c74-47ae-b2fa-01fa4e8bb5f2",
"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-08T12:12:10.8506674+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "96c39988-7bb9-49bb-8e8b-5b45aea909dd",
"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": "082fe992-0d86-440f-960b-8714a32a41da",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-08T12:12:10.8506674+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "56c015a3-43ba-463a-85b4-206c8a07b4da"
},
"suggested_date_start": "2026-01-08T12:12:10.8506674+00:00",
"skill_id": "a45657d2-dd7a-47f4-ab99-99c8884ab1a5",
"skill_code": "sample string 32",
"skill": {
"id": "90a552d5-bf10-413d-95c3-d494617090af",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a7efb7f2-aaf2-4367-abac-d54ebdeefaf0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "38a11350-1dc8-43f8-99f1-81eaede7f595",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b0e33b6-423f-4a22-a83f-d90738c6b9ed",
"db_currency_id": "1ae7d751-2d02-45b3-af6e-e751e4ab7871",
"db_language_id": "2cdf45b6-7c74-47ae-b2fa-01fa4e8bb5f2",
"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-08T12:12:10.8506674+00:00"
},
"modified_dateutc": "2026-01-08T12:12:10.8506674+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "cfc3d029-d899-4087-bc99-6f5c2813f1ca",
"date_reported_by_company": "2026-01-08T12:12:10.8506674+00:00",
"id2": 36,
"company_id": "385d2cd8-8aee-4ccd-adac-38dd6c598584",
"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": "0d716242-f14e-412f-9efc-3f85df9c2099",
"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-08T12:12:10.8506674+00:00"
},
"work_instruction_details_id": "7b61dfbc-3771-4da5-8d46-a82e039eda36",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b482457e-649f-49d9-81ef-9676432b6ba1",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "98b2b5f3-76dd-4fae-830f-c102345652bd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-08T12:12:10.8506674+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": "27ea4bb9-1e5f-4fea-a511-00ee1122f9f1",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-08T12:12:10.8506674+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.