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": "d937bb81-ac78-42d8-9778-9d0467912c5d",
"jobs_id": "49755a6f-98dc-4754-a144-47e49798d58d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0ff6f2d3-11d1-4e74-925a-fb385ee378aa",
"_parent_id": "bb61b318-d3ef-4f7b-b92d-077309d4ff7a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3ae8d8b4-f8f5-46ca-ba56-fc67086c1562",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b5ffdb6b-9db3-4e69-bbbf-8a942f5b9635",
"_parent_id": "bb681756-17ed-4b8d-b45d-e7cdd93abc83",
"root_parent_id": "0994a323-a29c-46e6-9e2a-6126246a1881",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7aca42f4-774f-482c-8bd1-6616b166f0ff",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "58e737ce-f323-42e9-abbf-83701f11c0f3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e4706e77-8406-4fb1-af2f-5182723ef8ab",
"_parent_code": "sample string 6",
"sales_organization_id": "d23e27a4-2ad8-41f9-b8fb-0e302bd373e7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ec71e15d-9b58-4bbc-89e0-bd1f71eb630b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e132428-d3e8-4b8c-8c21-33aceb83efe8",
"db_currency_id": "efa7f5c0-4036-487e-b812-88d7ae527118",
"db_language_id": "1c369e8e-bfae-4606-9cd2-d8f9094d4e03",
"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-03-18T06:08:08.6767419+00:00"
},
"modified_dateutc": "2026-03-18T06:08:08.6767419+00:00"
},
"equipment_model_id": "1611fa32-b7fc-4054-a11a-18deaab4fb50",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2b5f5af2-6d05-40c6-b83c-f9dfa1311ffb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ebac0d7a-0aae-408a-93ea-263f3adb734a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "20889709-859b-4f50-a423-ddfde1feb7cc",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "42fc93ae-799e-4af9-a57b-aee83f40be2e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ec71e15d-9b58-4bbc-89e0-bd1f71eb630b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e132428-d3e8-4b8c-8c21-33aceb83efe8",
"db_currency_id": "efa7f5c0-4036-487e-b812-88d7ae527118",
"db_language_id": "1c369e8e-bfae-4606-9cd2-d8f9094d4e03",
"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-03-18T06:08:08.6767419+00:00"
},
"modified_dateutc": "2026-03-18T06:08:08.6767419+00:00"
},
"equipment_family_id": "f46f2c4c-fcdf-4251-9496-f5bae000761a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "58e737ce-f323-42e9-abbf-83701f11c0f3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e4706e77-8406-4fb1-af2f-5182723ef8ab",
"_parent_code": "sample string 6",
"sales_organization_id": "d23e27a4-2ad8-41f9-b8fb-0e302bd373e7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ec71e15d-9b58-4bbc-89e0-bd1f71eb630b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e132428-d3e8-4b8c-8c21-33aceb83efe8",
"db_currency_id": "efa7f5c0-4036-487e-b812-88d7ae527118",
"db_language_id": "1c369e8e-bfae-4606-9cd2-d8f9094d4e03",
"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-03-18T06:08:08.6767419+00:00"
},
"modified_dateutc": "2026-03-18T06:08:08.6767419+00:00"
},
"date_in_production_since": "2026-03-18T06:08:08.6767419+00:00",
"date_out_of_production_since": "2026-03-18T06:08:08.6767419+00:00",
"date_end_support": "2026-03-18T06:08:08.6767419+00:00",
"sales_organization_id": "9a5d6d50-6328-415a-ad96-2d89ab9d6fe0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ec71e15d-9b58-4bbc-89e0-bd1f71eb630b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e132428-d3e8-4b8c-8c21-33aceb83efe8",
"db_currency_id": "efa7f5c0-4036-487e-b812-88d7ae527118",
"db_language_id": "1c369e8e-bfae-4606-9cd2-d8f9094d4e03",
"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-03-18T06:08:08.6767419+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-03-18T06:08:08.6767419+00:00"
},
"project_status_id": "7a33b787-a5dc-4749-8d30-4643d50e21da",
"project_status_code": "sample string 10",
"project_status": {
"id": "1fe09da4-2907-4500-9062-c7a815878b64",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ce65ed20-c43f-4bda-b62c-db563b19175e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ec71e15d-9b58-4bbc-89e0-bd1f71eb630b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e132428-d3e8-4b8c-8c21-33aceb83efe8",
"db_currency_id": "efa7f5c0-4036-487e-b812-88d7ae527118",
"db_language_id": "1c369e8e-bfae-4606-9cd2-d8f9094d4e03",
"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-03-18T06:08:08.6767419+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-18T06:08:08.6767419+00:00"
},
"company_id": "69f5f436-f7db-4667-9f83-b0b9cb58501f",
"company_code": "sample string 12",
"db_address_id": "2e04ff35-77b2-428e-a76c-fc26a5ee1d23",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "19d555b7-02e8-4b97-9beb-44848b933efd",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c73e59a0-9be9-48e6-8c91-3798627b27c4",
"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-03-18T06:08:08.6767419+00:00",
"date_create": "2026-03-18T06:08:08.6767419+00:00",
"date_update": "2026-03-18T06:08:08.6767419+00:00",
"updated_by_user_id": "cef67897-a7c9-4009-bedc-e3fb4bd7df06",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-18T06:08:08.6767419+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-03-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-18T06:08:08.6767419+00:00",
"date_last_job": "2026-03-18T06:08:08.6767419+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-18T06:08:08.6767419+00:00",
"modified_dateutc": "2026-03-18T06:08:08.6767419+00:00",
"is_mobile_installation": true
},
"job_type_id": "b251ed81-3074-47e3-ad0d-e820ad5903f9",
"job_type_code": "sample string 7",
"job_type": {
"id": "0cbd003e-bf4b-4c93-be5f-0c26c9b802b7",
"name": "sample string 2",
"sales_organization_id": "1537e89d-b8be-4628-823c-24b3c1d2c66c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-18T06:08:08.6767419+00:00",
"code": "sample string 7"
},
"job_priority_id": "fc90b8b3-5844-4576-b008-ea442ecd43e5",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "01e9ed24-114a-4846-a79f-77b860d8c73a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f1d81e58-71db-43e6-a59b-8680d8749d5a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ec71e15d-9b58-4bbc-89e0-bd1f71eb630b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e132428-d3e8-4b8c-8c21-33aceb83efe8",
"db_currency_id": "efa7f5c0-4036-487e-b812-88d7ae527118",
"db_language_id": "1c369e8e-bfae-4606-9cd2-d8f9094d4e03",
"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-03-18T06:08:08.6767419+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-18T06:08:08.6767419+00:00"
},
"job_status_id": "b7fcb8ee-4a43-4686-a28e-22cdbec5979c",
"job_status_code": "sample string 11",
"db_address_id": "d4e054d4-bc48-4740-87e3-79b4686de5bf",
"contact_id": "42788d2b-6592-4fdd-ab56-553a1f3563ad",
"requested_by_company_id": "5c87f769-d5a5-4db6-acb8-e58366f6a22a",
"requested_by_contact_id": "cca87bf4-c96c-441c-bedf-e55caabff2c8",
"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-03-18T06:08:08.6767419+00:00",
"due_date": "2026-03-18T06:08:08.6767419+00:00",
"date_create": "2026-03-18T06:08:08.6767419+00:00",
"date_update": "2026-03-18T06:08:08.6767419+00:00",
"date_closed": "2026-03-18T06:08:08.6767419+00:00",
"suggested_user_id": "4b421d04-c6df-4879-b73c-0830efdc27ad",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f3c4a3a7-fd90-42bc-bef4-c69adf072491",
"db_language_id": "a5fcce15-c6a9-421e-b80b-69e59ba69f28",
"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-03-18T06:08:08.6767419+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ef785565-3857-4106-a0cf-0e92f77daa33",
"sales_organization": {
"id": "ec71e15d-9b58-4bbc-89e0-bd1f71eb630b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e132428-d3e8-4b8c-8c21-33aceb83efe8",
"db_currency_id": "efa7f5c0-4036-487e-b812-88d7ae527118",
"db_language_id": "1c369e8e-bfae-4606-9cd2-d8f9094d4e03",
"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-03-18T06:08:08.6767419+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "83563167-1683-4055-a46f-ed095ad0c6f2",
"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": "d461ed5d-33f4-453d-b817-724dd41727ba",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-18T06:08:08.6767419+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ed9122c9-18ff-48e3-9be7-c6a8a67d628a"
},
"suggested_date_start": "2026-03-18T06:08:08.6767419+00:00",
"skill_id": "4e2da9ca-ad2a-4085-a31c-d74c439b651d",
"skill_code": "sample string 32",
"skill": {
"id": "99f75766-a778-4e8a-826e-3546bdbfc182",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "316d32e3-8456-4d99-9797-5674c8e73efc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ec71e15d-9b58-4bbc-89e0-bd1f71eb630b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e132428-d3e8-4b8c-8c21-33aceb83efe8",
"db_currency_id": "efa7f5c0-4036-487e-b812-88d7ae527118",
"db_language_id": "1c369e8e-bfae-4606-9cd2-d8f9094d4e03",
"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-03-18T06:08:08.6767419+00:00"
},
"modified_dateutc": "2026-03-18T06:08:08.6767419+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b779a664-c5c8-4aa8-a265-ce164a089bb4",
"date_reported_by_company": "2026-03-18T06:08:08.6767419+00:00",
"id2": 36,
"company_id": "56c5720f-aca1-43a8-9872-20734eb5ad62",
"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": "8176182a-1d19-4faf-9528-ddbcda516f91",
"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-03-18T06:08:08.6767419+00:00"
},
"work_instruction_details_id": "770963b7-8bea-4680-b68f-e6b8b5002fcd",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "38f3c0b5-203d-4dd0-9c29-17da53563fc4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "112d1109-7491-4cfb-9807-76f546c12627",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-18T06:08:08.6767419+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": "553a3b13-d027-4b14-9614-d3c481c26598",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-18T06:08:08.6767419+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.