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": "c56da56b-4308-4088-96a7-1e2753dfbd3c",
"jobs_id": "c32def00-7885-4cd3-91c4-b261d0a492f0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a696f91f-defa-49c7-aaa0-0ec21459d5af",
"_parent_id": "36f80613-e353-4214-9fbb-d064264761b1",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b23334db-7685-43ee-9b62-6d96dd55c2b8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a2e08d27-dad7-46ae-ba8f-52814d510364",
"_parent_id": "cf0f81da-e68b-45d9-b5fe-27a95fa08d00",
"root_parent_id": "7dcdbfa8-a72c-45ef-90b4-f4abfbb0a626",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f05de0ce-e597-42f3-a4f3-784bcf92987d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "117a6723-9976-4b79-9742-0ccc5dfdfae5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "49209a30-d957-4e29-83c9-c71bdfaac5a1",
"_parent_code": "sample string 6",
"sales_organization_id": "d062d5c1-88a7-4b52-abec-1e303a014dc5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "50464f79-4a97-4307-b333-fc090e585332",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d037c4f6-80f8-4f01-8413-83956785315a",
"db_currency_id": "cd793cc3-98d3-4a3d-b8e5-3f91d9f4443e",
"db_language_id": "4cceffa2-76eb-4b27-a2c9-0add1efef956",
"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-15T06:21:55.012214+00:00"
},
"modified_dateutc": "2026-01-15T06:21:55.012214+00:00"
},
"equipment_model_id": "d2a4484d-54f4-45ff-b3d4-253f043a2d85",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e9562379-1ae7-4096-b8b1-b624ac4a3278",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ee90cfa8-1eab-4337-81b2-4b8b3409c1e3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2742870b-05d7-4b47-a64e-375ad48d0346",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e2cb7aee-3bb4-4b45-a37f-1e61ef824a91",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "50464f79-4a97-4307-b333-fc090e585332",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d037c4f6-80f8-4f01-8413-83956785315a",
"db_currency_id": "cd793cc3-98d3-4a3d-b8e5-3f91d9f4443e",
"db_language_id": "4cceffa2-76eb-4b27-a2c9-0add1efef956",
"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-15T06:21:55.012214+00:00"
},
"modified_dateutc": "2026-01-15T06:21:55.012214+00:00"
},
"equipment_family_id": "f893a4af-52e3-4fe7-8ad7-bc1ae33af7f8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "117a6723-9976-4b79-9742-0ccc5dfdfae5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "49209a30-d957-4e29-83c9-c71bdfaac5a1",
"_parent_code": "sample string 6",
"sales_organization_id": "d062d5c1-88a7-4b52-abec-1e303a014dc5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "50464f79-4a97-4307-b333-fc090e585332",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d037c4f6-80f8-4f01-8413-83956785315a",
"db_currency_id": "cd793cc3-98d3-4a3d-b8e5-3f91d9f4443e",
"db_language_id": "4cceffa2-76eb-4b27-a2c9-0add1efef956",
"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-15T06:21:55.012214+00:00"
},
"modified_dateutc": "2026-01-15T06:21:55.012214+00:00"
},
"date_in_production_since": "2026-01-15T06:21:55.012214+00:00",
"date_out_of_production_since": "2026-01-15T06:21:55.012214+00:00",
"date_end_support": "2026-01-15T06:21:55.012214+00:00",
"sales_organization_id": "cd16cbc5-fb18-4f9e-aa8e-ec3654713c51",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "50464f79-4a97-4307-b333-fc090e585332",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d037c4f6-80f8-4f01-8413-83956785315a",
"db_currency_id": "cd793cc3-98d3-4a3d-b8e5-3f91d9f4443e",
"db_language_id": "4cceffa2-76eb-4b27-a2c9-0add1efef956",
"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-15T06:21:55.012214+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-15T06:21:55.012214+00:00"
},
"project_status_id": "02964dcf-cd4f-4e6a-a6bf-480ed1b2f15a",
"project_status_code": "sample string 10",
"project_status": {
"id": "54a1db55-22c8-4742-be0c-0a6733374680",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9b7c896d-c272-4793-b976-48cd9efa185b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "50464f79-4a97-4307-b333-fc090e585332",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d037c4f6-80f8-4f01-8413-83956785315a",
"db_currency_id": "cd793cc3-98d3-4a3d-b8e5-3f91d9f4443e",
"db_language_id": "4cceffa2-76eb-4b27-a2c9-0add1efef956",
"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-15T06:21:55.012214+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-15T06:21:55.012214+00:00"
},
"company_id": "5d81ab28-34ca-4447-a989-d0063c7d3dc5",
"company_code": "sample string 12",
"db_address_id": "6683de18-e146-48a4-b451-eff06f53d3ef",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "88e837a3-84c6-4677-962e-8b1cd5f16107",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f526a6a2-2729-4403-8df9-33f63a711e0e",
"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-15T06:21:55.012214+00:00",
"date_create": "2026-01-15T06:21:55.012214+00:00",
"date_update": "2026-01-15T06:21:55.012214+00:00",
"updated_by_user_id": "e478594f-4c9b-4e3e-93e0-59997be42dae",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-15T06:21:55.012214+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-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-15T06:21:55.012214+00:00",
"date_last_job": "2026-01-15T06:21:55.012214+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-15T06:21:55.012214+00:00",
"modified_dateutc": "2026-01-15T06:21:55.012214+00:00",
"is_mobile_installation": true
},
"job_type_id": "8ee59027-5546-46b9-824a-3a7e7a070f3e",
"job_type_code": "sample string 7",
"job_type": {
"id": "c0f9d5d6-b79d-4b69-ae50-99ca1ded0418",
"name": "sample string 2",
"sales_organization_id": "16e8a4d6-3325-40d0-96c6-345f12904458",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-15T06:21:55.012214+00:00",
"code": "sample string 7"
},
"job_priority_id": "689eb74e-8cff-4d23-8130-0bea1801e906",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d173ed84-760c-4d1a-bdff-81bafdda0896",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2b8406d4-ab0b-460d-9b48-8187361e2df0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "50464f79-4a97-4307-b333-fc090e585332",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d037c4f6-80f8-4f01-8413-83956785315a",
"db_currency_id": "cd793cc3-98d3-4a3d-b8e5-3f91d9f4443e",
"db_language_id": "4cceffa2-76eb-4b27-a2c9-0add1efef956",
"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-15T06:21:55.012214+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-15T06:21:55.012214+00:00"
},
"job_status_id": "2ff92e50-a6c5-4477-bfc2-cea8ee8570da",
"job_status_code": "sample string 11",
"db_address_id": "3e75e6c3-2588-489e-a63c-db997e3918f1",
"contact_id": "eb7acbb2-f7b4-4c8f-9af6-9cdfebf3f87a",
"requested_by_company_id": "d81a2064-861e-45a1-9369-713555f92279",
"requested_by_contact_id": "5517e57f-75eb-4f4b-a0cd-242af8cb6a52",
"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-15T06:21:55.012214+00:00",
"due_date": "2026-01-15T06:21:55.012214+00:00",
"date_create": "2026-01-15T06:21:55.012214+00:00",
"date_update": "2026-01-15T06:21:55.012214+00:00",
"date_closed": "2026-01-15T06:21:55.012214+00:00",
"suggested_user_id": "1545f88b-23bf-46fa-ae59-57909cb87b6e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8fc8c9c0-b63c-4d7b-9f7c-52a9c218fab8",
"db_language_id": "e87e5ee4-0ed9-4de9-a307-b372777adcde",
"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-15T06:21:55.012214+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "592b4b5c-2260-4bd9-aceb-7fee916933a8",
"sales_organization": {
"id": "50464f79-4a97-4307-b333-fc090e585332",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d037c4f6-80f8-4f01-8413-83956785315a",
"db_currency_id": "cd793cc3-98d3-4a3d-b8e5-3f91d9f4443e",
"db_language_id": "4cceffa2-76eb-4b27-a2c9-0add1efef956",
"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-15T06:21:55.012214+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "48319fdd-73c8-42e3-a4b6-8758755c6ab8",
"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": "d3855fea-62fb-438c-b391-7d8c2a3e0d58",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-15T06:21:55.012214+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ff12df7e-4a7c-4245-b68e-bd54fb94d5a9"
},
"suggested_date_start": "2026-01-15T06:21:55.012214+00:00",
"skill_id": "df60e365-6fb9-4741-9c07-dd29e069b9f3",
"skill_code": "sample string 32",
"skill": {
"id": "1d458965-3ce6-4c93-b575-2dd2c2c754ae",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a520377f-346f-4f31-a07e-1dccbed786d3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "50464f79-4a97-4307-b333-fc090e585332",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d037c4f6-80f8-4f01-8413-83956785315a",
"db_currency_id": "cd793cc3-98d3-4a3d-b8e5-3f91d9f4443e",
"db_language_id": "4cceffa2-76eb-4b27-a2c9-0add1efef956",
"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-15T06:21:55.012214+00:00"
},
"modified_dateutc": "2026-01-15T06:21:55.012214+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "15b23315-6802-4efd-b176-ba3c80878133",
"date_reported_by_company": "2026-01-15T06:21:55.012214+00:00",
"id2": 36,
"company_id": "8c02a7af-e686-4b10-b50a-d5272702386d",
"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": "8237c21a-ff76-4d4e-b0bb-76908c728583",
"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-15T06:21:55.012214+00:00"
},
"work_instruction_details_id": "34504694-7ee9-486b-ac7c-efb7ad48a8d0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ba3af275-a0c9-445b-af30-9626fbe5c678",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0f1f0b1b-b4bb-4bba-8e4e-2bc77c68ccfb",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-15T06:21:55.012214+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": "7575a68e-0341-40a8-9a90-5a290fd3bb48",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-15T06:21:55.012214+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.