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": "9c50f4fd-8826-422d-8320-efc646addf67",
"jobs_id": "11adfa34-f6f4-4c59-aa05-f03e5df1242b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c7dd1a2a-af69-4d9d-a82e-6f02d6d2e814",
"_parent_id": "75f42673-4805-4155-9f29-e75101d0991f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "66951f48-54a5-4e7b-a0ba-f4de8e7d64b0",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3af7b196-7cdc-4b4d-8f21-4bbe9aaff15d",
"_parent_id": "4ee6f812-7a94-48b0-abea-7327b025873d",
"root_parent_id": "3b4559ee-3080-4744-b0ef-215ada789f11",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "472b52d5-726f-4dcf-a1cb-f5d61ef6747b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ecac7221-da3a-40a9-a58b-4fbec3963e37",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "449cd9e8-ee08-4362-9315-77bb28ec7a0e",
"_parent_code": "sample string 6",
"sales_organization_id": "613ad112-961b-4306-850b-c06683d414fc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "34577185-663c-40d9-9a7b-7f9c1cdb4b2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70301d51-29f6-491e-8fed-ade4c11f5dc1",
"db_currency_id": "eba902db-26ad-4f56-aafb-6c024ffcf884",
"db_language_id": "024eb8e6-31df-47a3-a336-703458c719ff",
"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-02-25T06:45:40.8512771+00:00"
},
"modified_dateutc": "2026-02-25T06:45:40.8512771+00:00"
},
"equipment_model_id": "063fe532-1306-4cd4-aea8-95ef641d941b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ec89c6c1-43fd-4fda-98bc-ce3b39c631b6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "85cb4355-d462-4e5f-b5c4-ba509208e416",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "05b76387-1d8c-4652-9af2-45038e6573cd",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2a9d0178-9d7e-4200-884a-079ad07c5b35",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "34577185-663c-40d9-9a7b-7f9c1cdb4b2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70301d51-29f6-491e-8fed-ade4c11f5dc1",
"db_currency_id": "eba902db-26ad-4f56-aafb-6c024ffcf884",
"db_language_id": "024eb8e6-31df-47a3-a336-703458c719ff",
"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-02-25T06:45:40.8512771+00:00"
},
"modified_dateutc": "2026-02-25T06:45:40.8512771+00:00"
},
"equipment_family_id": "2eabc0fe-a736-42db-b64a-445880972eb8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ecac7221-da3a-40a9-a58b-4fbec3963e37",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "449cd9e8-ee08-4362-9315-77bb28ec7a0e",
"_parent_code": "sample string 6",
"sales_organization_id": "613ad112-961b-4306-850b-c06683d414fc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "34577185-663c-40d9-9a7b-7f9c1cdb4b2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70301d51-29f6-491e-8fed-ade4c11f5dc1",
"db_currency_id": "eba902db-26ad-4f56-aafb-6c024ffcf884",
"db_language_id": "024eb8e6-31df-47a3-a336-703458c719ff",
"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-02-25T06:45:40.8512771+00:00"
},
"modified_dateutc": "2026-02-25T06:45:40.8512771+00:00"
},
"date_in_production_since": "2026-02-25T06:45:40.8512771+00:00",
"date_out_of_production_since": "2026-02-25T06:45:40.8512771+00:00",
"date_end_support": "2026-02-25T06:45:40.8512771+00:00",
"sales_organization_id": "79863270-8bc9-4559-9861-0095d460d17b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "34577185-663c-40d9-9a7b-7f9c1cdb4b2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70301d51-29f6-491e-8fed-ade4c11f5dc1",
"db_currency_id": "eba902db-26ad-4f56-aafb-6c024ffcf884",
"db_language_id": "024eb8e6-31df-47a3-a336-703458c719ff",
"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-02-25T06:45:40.8512771+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-02-25T06:45:40.8512771+00:00"
},
"project_status_id": "fa832560-3cb9-4d80-8dcc-e877b93188a0",
"project_status_code": "sample string 10",
"project_status": {
"id": "f7d8f21d-997e-42a0-afbc-5f86c51f312b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4485ee77-bbb7-4429-9718-3e3d1e1a03ea",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "34577185-663c-40d9-9a7b-7f9c1cdb4b2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70301d51-29f6-491e-8fed-ade4c11f5dc1",
"db_currency_id": "eba902db-26ad-4f56-aafb-6c024ffcf884",
"db_language_id": "024eb8e6-31df-47a3-a336-703458c719ff",
"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-02-25T06:45:40.8512771+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-25T06:45:40.8512771+00:00"
},
"company_id": "a679bbbd-2144-41c6-bf95-2dc88713dbcf",
"company_code": "sample string 12",
"db_address_id": "a5f8d063-7669-4936-933d-df74c74d3946",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ccf8ee78-c8dc-44f8-b983-b6d40632c967",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7833a81d-dd19-4eca-88b5-a355308ae071",
"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-02-25T06:45:40.8512771+00:00",
"date_create": "2026-02-25T06:45:40.8512771+00:00",
"date_update": "2026-02-25T06:45:40.8512771+00:00",
"updated_by_user_id": "c68a0f06-813f-4388-aae3-80681c43499a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-25T06:45:40.8512771+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-02-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-25T06:45:40.8512771+00:00",
"date_last_job": "2026-02-25T06:45:40.8512771+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-25T06:45:40.8512771+00:00",
"modified_dateutc": "2026-02-25T06:45:40.8512771+00:00",
"is_mobile_installation": true
},
"job_type_id": "43c75721-bd3c-40c0-969b-0ecf191a3dc8",
"job_type_code": "sample string 7",
"job_type": {
"id": "830186af-b0ba-4c49-8d28-781a996452c1",
"name": "sample string 2",
"sales_organization_id": "36ca6ba4-eb45-4fa3-bd42-96ab1ea7ec53",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-25T06:45:40.8512771+00:00",
"code": "sample string 7"
},
"job_priority_id": "1ffac9ec-d4ac-4acd-9f01-a62b4f2fdb10",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "93f94489-d679-4868-90fd-1403054e1ec6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6311d8b7-53de-419e-854d-975604f030f0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "34577185-663c-40d9-9a7b-7f9c1cdb4b2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70301d51-29f6-491e-8fed-ade4c11f5dc1",
"db_currency_id": "eba902db-26ad-4f56-aafb-6c024ffcf884",
"db_language_id": "024eb8e6-31df-47a3-a336-703458c719ff",
"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-02-25T06:45:40.8512771+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-25T06:45:40.8512771+00:00"
},
"job_status_id": "191df76b-19fa-4a82-8546-688f8d21cc42",
"job_status_code": "sample string 11",
"db_address_id": "bebbbfc8-1dbb-4164-9b69-b58ff29fa10a",
"contact_id": "895295de-fe1f-4a17-93b6-c2d811efdbb1",
"requested_by_company_id": "96c0dddb-591c-43c0-ab4a-01f4a502694a",
"requested_by_contact_id": "0937d50b-bf15-42fa-a443-2817b6bb416f",
"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-02-25T06:45:40.8512771+00:00",
"due_date": "2026-02-25T06:45:40.8512771+00:00",
"date_create": "2026-02-25T06:45:40.8512771+00:00",
"date_update": "2026-02-25T06:45:40.8512771+00:00",
"date_closed": "2026-02-25T06:45:40.8512771+00:00",
"suggested_user_id": "7bc40bc1-22dc-43d3-ab8c-9c4edd0e8571",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "aaec1e6a-0869-4024-8469-775045437097",
"db_language_id": "a07cf845-bf03-4697-9f99-87fdb9e615f2",
"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-02-25T06:45:40.8512771+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a6a2fab2-82bb-4782-b232-27f88bd03306",
"sales_organization": {
"id": "34577185-663c-40d9-9a7b-7f9c1cdb4b2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70301d51-29f6-491e-8fed-ade4c11f5dc1",
"db_currency_id": "eba902db-26ad-4f56-aafb-6c024ffcf884",
"db_language_id": "024eb8e6-31df-47a3-a336-703458c719ff",
"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-02-25T06:45:40.8512771+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "be31c56c-4711-4710-8c57-899a9be2118b",
"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": "67c72234-1279-4895-a29e-350d9c3185b1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-25T06:45:40.8512771+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "675d5c32-49b0-4735-9dd3-c18d7c1a26b1"
},
"suggested_date_start": "2026-02-25T06:45:40.8512771+00:00",
"skill_id": "cb50825e-331a-4fd7-a640-80e56973a308",
"skill_code": "sample string 32",
"skill": {
"id": "677a8a40-ce38-4e16-b68a-db2d858f9d3d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "bd7453ca-d897-4d4d-90b7-3a2551ee2809",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "34577185-663c-40d9-9a7b-7f9c1cdb4b2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70301d51-29f6-491e-8fed-ade4c11f5dc1",
"db_currency_id": "eba902db-26ad-4f56-aafb-6c024ffcf884",
"db_language_id": "024eb8e6-31df-47a3-a336-703458c719ff",
"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-02-25T06:45:40.8512771+00:00"
},
"modified_dateutc": "2026-02-25T06:45:40.8512771+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "33e54f74-ab74-44d0-aba8-aceb4670f81f",
"date_reported_by_company": "2026-02-25T06:45:40.8512771+00:00",
"id2": 36,
"company_id": "e74f0c0e-7f6f-4a55-b364-2bedd1310003",
"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": "3de6612a-258e-4e09-9e4a-c6ad1b36b2b8",
"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-02-25T06:45:40.8512771+00:00"
},
"work_instruction_details_id": "5302e40e-b261-4c17-90a9-d01f05cd1a0b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "cdd8ec72-6905-487f-9020-c6656fd078dc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "39a55307-6d32-4691-863f-087731f78046",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-25T06:45:40.8512771+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": "55998961-4953-4c2c-8c52-d2aa0621a594",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-25T06:45:40.8512771+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.