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": "3c225910-bbbd-4998-b405-e7d3740f3975",
"jobs_id": "eab0ef96-ded5-4f86-9761-c7cd8cd63587",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8641cc96-606b-47db-af16-5edb8bbaea54",
"_parent_id": "c88eeaff-64c2-464c-ab54-bfd0507783f1",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "fd19ffe5-782f-45ff-912d-07c8d92d4e3a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5b2be0d7-3e62-43bb-9a17-2441e9ac0a41",
"_parent_id": "38b01aa2-1348-4f8a-8c42-02d3c8ea964b",
"root_parent_id": "b1994b11-5a78-46a3-b0b6-d7f3617de7a9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "265603c8-4fe9-475d-a767-62f9d639be72",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "93bcd59c-4eb0-4ebb-b28e-5f4c8ea1eb24",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ac50e804-eb05-4b47-822e-eee3b75ff1fa",
"_parent_code": "sample string 6",
"sales_organization_id": "a909261d-eb56-4f6a-a439-c404548961b9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c22c5d0a-0e45-4dd8-9a60-e8da1ad9dcac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8860caf-41e3-4dc5-b847-a6a8897e1ac6",
"db_currency_id": "afdba898-8beb-49fe-a001-5ff3b4ae62ef",
"db_language_id": "421d8f9b-507f-4850-b533-81695ba91ec9",
"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-07-13T05:12:39.9603033+00:00"
},
"modified_dateutc": "2026-07-13T05:12:39.9603033+00:00"
},
"equipment_model_id": "78fd5e21-8d29-4acc-8c90-de7f2ce3aa7c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "11bae591-e5c9-4998-8ced-c64cae67eba6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3dc9f63d-e3fb-432b-a2a6-8c9068548237",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1dcf4232-f96b-4732-aa15-7984ea1259db",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a0850c78-bd29-4a35-b137-f929086ceb71",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c22c5d0a-0e45-4dd8-9a60-e8da1ad9dcac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8860caf-41e3-4dc5-b847-a6a8897e1ac6",
"db_currency_id": "afdba898-8beb-49fe-a001-5ff3b4ae62ef",
"db_language_id": "421d8f9b-507f-4850-b533-81695ba91ec9",
"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-07-13T05:12:39.9603033+00:00"
},
"modified_dateutc": "2026-07-13T05:12:39.9603033+00:00"
},
"equipment_family_id": "7c0b7618-68b7-4bdb-b95a-a71e702c3412",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "93bcd59c-4eb0-4ebb-b28e-5f4c8ea1eb24",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ac50e804-eb05-4b47-822e-eee3b75ff1fa",
"_parent_code": "sample string 6",
"sales_organization_id": "a909261d-eb56-4f6a-a439-c404548961b9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c22c5d0a-0e45-4dd8-9a60-e8da1ad9dcac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8860caf-41e3-4dc5-b847-a6a8897e1ac6",
"db_currency_id": "afdba898-8beb-49fe-a001-5ff3b4ae62ef",
"db_language_id": "421d8f9b-507f-4850-b533-81695ba91ec9",
"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-07-13T05:12:39.9603033+00:00"
},
"modified_dateutc": "2026-07-13T05:12:39.9603033+00:00"
},
"date_in_production_since": "2026-07-13T05:12:39.9603033+00:00",
"date_out_of_production_since": "2026-07-13T05:12:39.9603033+00:00",
"date_end_support": "2026-07-13T05:12:39.9603033+00:00",
"sales_organization_id": "4ededc7c-85f7-4486-be8d-d296921f07fd",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c22c5d0a-0e45-4dd8-9a60-e8da1ad9dcac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8860caf-41e3-4dc5-b847-a6a8897e1ac6",
"db_currency_id": "afdba898-8beb-49fe-a001-5ff3b4ae62ef",
"db_language_id": "421d8f9b-507f-4850-b533-81695ba91ec9",
"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-07-13T05:12:39.9603033+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-07-13T05:12:39.9603033+00:00"
},
"project_status_id": "464e1d27-c8d5-4b60-b4a7-42ab5e2af8ee",
"project_status_code": "sample string 10",
"project_status": {
"id": "ab01f169-8f90-4ded-8504-d706564ec9b6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6798803e-3fe1-4a3d-8601-a7b8bf025882",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c22c5d0a-0e45-4dd8-9a60-e8da1ad9dcac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8860caf-41e3-4dc5-b847-a6a8897e1ac6",
"db_currency_id": "afdba898-8beb-49fe-a001-5ff3b4ae62ef",
"db_language_id": "421d8f9b-507f-4850-b533-81695ba91ec9",
"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-07-13T05:12:39.9603033+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-13T05:12:39.9603033+00:00"
},
"company_id": "f7f84ccb-c4a9-4020-9bf0-4ed519bda7ca",
"company_code": "sample string 12",
"db_address_id": "52eb4a76-5350-478a-b2d8-93bdbb9deb99",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6d160a6b-6e1b-4b61-8041-660a3b48c2d9",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "97fcd49a-8ce3-4a1a-b3b6-c1c711c391b1",
"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-07-13T05:12:39.9603033+00:00",
"date_create": "2026-07-13T05:12:39.9603033+00:00",
"date_update": "2026-07-13T05:12:39.9603033+00:00",
"updated_by_user_id": "786c4ffb-f50f-45a9-9d3e-cf2ac6029888",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-13T05:12:39.9603033+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-07-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-13T05:12:39.9603033+00:00",
"date_last_job": "2026-07-13T05:12:39.9603033+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-13T05:12:39.9603033+00:00",
"modified_dateutc": "2026-07-13T05:12:39.9603033+00:00",
"is_mobile_installation": true
},
"job_type_id": "d4047a12-468b-4a00-9da8-aa1f185a3ca0",
"job_type_code": "sample string 7",
"job_type": {
"id": "38496c54-9eea-425e-9c19-3003ccbe632a",
"name": "sample string 2",
"sales_organization_id": "a088267d-6b89-4311-b3a2-2f0036760b6b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-13T05:12:39.9603033+00:00",
"code": "sample string 7"
},
"job_priority_id": "d1ccc606-42c6-4d0b-86d6-6f22f862aff1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5b0b72fa-4719-44b0-a8d7-fb84efdb5d9d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "394a2b04-fb9e-4767-a1fb-1c2d1108a1c0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c22c5d0a-0e45-4dd8-9a60-e8da1ad9dcac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8860caf-41e3-4dc5-b847-a6a8897e1ac6",
"db_currency_id": "afdba898-8beb-49fe-a001-5ff3b4ae62ef",
"db_language_id": "421d8f9b-507f-4850-b533-81695ba91ec9",
"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-07-13T05:12:39.9603033+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-13T05:12:39.9603033+00:00"
},
"job_status_id": "3a2f3c2e-9d99-4bcb-9112-3793b79df485",
"job_status_code": "sample string 11",
"db_address_id": "8b0ed10b-9248-4cd1-87fe-de136f0a65b7",
"contact_id": "3ce18e1c-55c2-489c-a71b-00e72029de36",
"requested_by_company_id": "26cf8256-9947-4686-a7e9-6f5654f4e6d8",
"requested_by_contact_id": "6d983eea-2239-4ba6-8dfa-7c135faa3058",
"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-07-13T05:12:39.9603033+00:00",
"due_date": "2026-07-13T05:12:39.9603033+00:00",
"date_create": "2026-07-13T05:12:39.9603033+00:00",
"date_update": "2026-07-13T05:12:39.9603033+00:00",
"date_closed": "2026-07-13T05:12:39.9603033+00:00",
"suggested_user_id": "3043a5d5-56cb-42ae-934c-44ab76a990c4",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8751bc4d-cf29-4d80-8085-5c26b98b4007",
"db_language_id": "dda56780-4d64-4ded-921f-a23e2ab8ef74",
"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-07-13T05:12:39.9603033+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c0d9bdb7-9dde-4d44-aaaa-0040f7cc3018",
"sales_organization": {
"id": "c22c5d0a-0e45-4dd8-9a60-e8da1ad9dcac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8860caf-41e3-4dc5-b847-a6a8897e1ac6",
"db_currency_id": "afdba898-8beb-49fe-a001-5ff3b4ae62ef",
"db_language_id": "421d8f9b-507f-4850-b533-81695ba91ec9",
"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-07-13T05:12:39.9603033+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "368ef28a-4e9d-40c6-b3c9-e372cb113cf6",
"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": "4ac15993-375e-4ec1-a29e-fa67a9fb2a09",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-13T05:12:39.9603033+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f9db88ac-49ee-4f38-872e-cb4eb9176f66"
},
"suggested_date_start": "2026-07-13T05:12:39.9603033+00:00",
"skill_id": "4e34a58e-b581-4e13-a5a7-f55532ad12fa",
"skill_code": "sample string 32",
"skill": {
"id": "ee265b46-a55d-49bb-bdb5-019ce074128d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e0afc94d-2c96-4511-b75d-c271861169d6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c22c5d0a-0e45-4dd8-9a60-e8da1ad9dcac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8860caf-41e3-4dc5-b847-a6a8897e1ac6",
"db_currency_id": "afdba898-8beb-49fe-a001-5ff3b4ae62ef",
"db_language_id": "421d8f9b-507f-4850-b533-81695ba91ec9",
"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-07-13T05:12:39.9603033+00:00"
},
"modified_dateutc": "2026-07-13T05:12:39.9603033+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "87db7a2a-2f9d-49af-8a30-32305309fc23",
"date_reported_by_company": "2026-07-13T05:12:39.9603033+00:00",
"id2": 36,
"company_id": "e9f0c8f7-a452-4f55-9a56-85c6cb9c8d63",
"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": "2616d9ee-7999-472e-a6c6-3a4b52a2d3fb",
"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-07-13T05:12:39.9603033+00:00"
},
"work_instruction_details_id": "5f77aa75-f525-477f-9efd-bb84c8d0f0bb",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c267b662-bb74-4dea-b7c7-c44d4a389cf9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "47d958f0-f0d0-4b60-bd7d-1951d1dd74a4",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-13T05:12:39.9603033+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": "b698ea6a-2446-4694-bc50-4cd29bf9fe9e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-13T05:12:39.9603033+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.