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": "06964f67-1868-4ac6-b5f6-d274e1fa2267",
"jobs_id": "4b047f4d-293b-412c-8d5b-f26034750f38",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "87a2f1f3-ae6e-4809-9f10-be2311b1c2bf",
"_parent_id": "6352bcd3-6b32-471e-8572-712186d96f6f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8fb624e8-c3c9-444c-beb3-285410c0522c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "687dcc0f-67b7-4ce6-8a81-9d70a5a85026",
"_parent_id": "b4702e91-8017-4b80-b975-d846849a82d3",
"root_parent_id": "f5920bba-9e08-4197-ba85-67db51a2414e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "10c986ac-757b-4db4-9308-752df8429dc6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "eebbfaf1-2c90-4846-a11a-4729e8727859",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2f627f58-3e05-411c-bb0d-79822eaf3ecb",
"_parent_code": "sample string 6",
"sales_organization_id": "706a2b47-09f5-4897-b30d-9bba8ed0f532",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3bfa3cf5-80dc-422f-8033-11e28856d69b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e57a67e-fb30-406a-8e25-cd20cd5755e4",
"db_currency_id": "b9e81ad7-0e43-4d30-b5c9-a5d7cb4cb4f2",
"db_language_id": "033b43ac-3f92-481b-b22d-2ac7d94c146f",
"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-01T01:34:11.5789595+00:00"
},
"modified_dateutc": "2026-03-01T01:34:11.5789595+00:00"
},
"equipment_model_id": "5b762360-bca0-4fbc-8da9-d81901b1ce10",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b9df53c2-fc9e-4e1d-be23-03161174630f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a54b4fd0-016a-419b-8203-166e35ad6056",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "aaeaa098-f372-4055-aa4a-a876c0ce61d2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a0c65cfe-08b0-478d-b875-4699b01d244d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3bfa3cf5-80dc-422f-8033-11e28856d69b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e57a67e-fb30-406a-8e25-cd20cd5755e4",
"db_currency_id": "b9e81ad7-0e43-4d30-b5c9-a5d7cb4cb4f2",
"db_language_id": "033b43ac-3f92-481b-b22d-2ac7d94c146f",
"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-01T01:34:11.5789595+00:00"
},
"modified_dateutc": "2026-03-01T01:34:11.5789595+00:00"
},
"equipment_family_id": "7c52f67d-fefc-4e25-b772-6fc265fcc5ef",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "eebbfaf1-2c90-4846-a11a-4729e8727859",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2f627f58-3e05-411c-bb0d-79822eaf3ecb",
"_parent_code": "sample string 6",
"sales_organization_id": "706a2b47-09f5-4897-b30d-9bba8ed0f532",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3bfa3cf5-80dc-422f-8033-11e28856d69b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e57a67e-fb30-406a-8e25-cd20cd5755e4",
"db_currency_id": "b9e81ad7-0e43-4d30-b5c9-a5d7cb4cb4f2",
"db_language_id": "033b43ac-3f92-481b-b22d-2ac7d94c146f",
"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-01T01:34:11.5789595+00:00"
},
"modified_dateutc": "2026-03-01T01:34:11.5789595+00:00"
},
"date_in_production_since": "2026-03-01T01:34:11.5789595+00:00",
"date_out_of_production_since": "2026-03-01T01:34:11.5789595+00:00",
"date_end_support": "2026-03-01T01:34:11.5789595+00:00",
"sales_organization_id": "e68898eb-18cc-4e22-85fd-bcbe4246b483",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3bfa3cf5-80dc-422f-8033-11e28856d69b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e57a67e-fb30-406a-8e25-cd20cd5755e4",
"db_currency_id": "b9e81ad7-0e43-4d30-b5c9-a5d7cb4cb4f2",
"db_language_id": "033b43ac-3f92-481b-b22d-2ac7d94c146f",
"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-01T01:34:11.5789595+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-01T01:34:11.5789595+00:00"
},
"project_status_id": "f8a5367d-b7ec-4692-869f-7d177a7dd6d7",
"project_status_code": "sample string 10",
"project_status": {
"id": "8915058b-2e4d-4cdb-80a2-1a5759393e44",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6a329d9c-bcc3-4d1f-9d41-889ca18f4f70",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3bfa3cf5-80dc-422f-8033-11e28856d69b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e57a67e-fb30-406a-8e25-cd20cd5755e4",
"db_currency_id": "b9e81ad7-0e43-4d30-b5c9-a5d7cb4cb4f2",
"db_language_id": "033b43ac-3f92-481b-b22d-2ac7d94c146f",
"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-01T01:34:11.5789595+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-01T01:34:11.5789595+00:00"
},
"company_id": "6c5ba9d9-d6d8-4f15-bb22-c92a61e389a2",
"company_code": "sample string 12",
"db_address_id": "28e473d6-40df-4c8d-a2b5-3f5ffe766d33",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3f914d55-1567-408e-b7b0-6f0c9d8717ba",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c5c0b97c-8140-4b2c-8b1c-88710b71ec69",
"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-01T01:34:11.5789595+00:00",
"date_create": "2026-03-01T01:34:11.5789595+00:00",
"date_update": "2026-03-01T01:34:11.5789595+00:00",
"updated_by_user_id": "60edc875-c86b-4e4e-a2d2-5ab4e8b04481",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-01T01:34:11.5789595+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-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-01T01:34:11.5789595+00:00",
"date_last_job": "2026-03-01T01:34:11.5789595+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-01T01:34:11.5789595+00:00",
"modified_dateutc": "2026-03-01T01:34:11.5789595+00:00",
"is_mobile_installation": true
},
"job_type_id": "fff8a407-95bd-45a7-b341-8e0a1572ec6d",
"job_type_code": "sample string 7",
"job_type": {
"id": "b9568fe0-7934-4f0d-93b9-84ca73119753",
"name": "sample string 2",
"sales_organization_id": "31413a95-c13b-4497-934e-2e9281f78007",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-01T01:34:11.5789595+00:00",
"code": "sample string 7"
},
"job_priority_id": "1c0a2495-51c0-4a3b-be2e-e49fe125524d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "58eb46de-fd41-416e-8fa2-04acb26deec9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f07a9580-a137-4613-86a3-254005a29dbb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3bfa3cf5-80dc-422f-8033-11e28856d69b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e57a67e-fb30-406a-8e25-cd20cd5755e4",
"db_currency_id": "b9e81ad7-0e43-4d30-b5c9-a5d7cb4cb4f2",
"db_language_id": "033b43ac-3f92-481b-b22d-2ac7d94c146f",
"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-01T01:34:11.5789595+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-01T01:34:11.5789595+00:00"
},
"job_status_id": "965285c4-b1ae-433b-8749-012fd9afb5c8",
"job_status_code": "sample string 11",
"db_address_id": "af4af894-27d8-413d-a020-4ae7b7943918",
"contact_id": "75cf53ac-cff1-41b1-8f7a-35d52fa61675",
"requested_by_company_id": "a5efb3ee-fa79-4804-a632-857cd515a4df",
"requested_by_contact_id": "04d681b7-b48b-4d93-9402-f1381fcfe4cb",
"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-01T01:34:11.5789595+00:00",
"due_date": "2026-03-01T01:34:11.5789595+00:00",
"date_create": "2026-03-01T01:34:11.5789595+00:00",
"date_update": "2026-03-01T01:34:11.5789595+00:00",
"date_closed": "2026-03-01T01:34:11.5789595+00:00",
"suggested_user_id": "e4c1343f-8958-4060-a78d-e3f22ec93430",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "54617f3d-569b-4380-be1d-b7db6f58a2d4",
"db_language_id": "e15a30f7-3871-4dae-960f-93cd8d7f493b",
"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-01T01:34:11.5789595+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d82f410e-dea2-4f0f-a849-4a8e898d7051",
"sales_organization": {
"id": "3bfa3cf5-80dc-422f-8033-11e28856d69b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e57a67e-fb30-406a-8e25-cd20cd5755e4",
"db_currency_id": "b9e81ad7-0e43-4d30-b5c9-a5d7cb4cb4f2",
"db_language_id": "033b43ac-3f92-481b-b22d-2ac7d94c146f",
"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-01T01:34:11.5789595+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f4f3afda-9345-48b8-9666-115b7eb5c93e",
"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": "6df4d8fa-b0b0-49e3-b8f0-d9ad02ff9800",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-01T01:34:11.5789595+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "50dbff07-c134-4be8-a20b-d1e1b7289cde"
},
"suggested_date_start": "2026-03-01T01:34:11.5789595+00:00",
"skill_id": "abf9e239-8165-44c2-a897-db90a6ba263d",
"skill_code": "sample string 32",
"skill": {
"id": "247441ba-e380-483b-95a4-c61ada49404f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "abe4ef44-cfd1-40e3-9fd3-7695140c1e14",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3bfa3cf5-80dc-422f-8033-11e28856d69b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e57a67e-fb30-406a-8e25-cd20cd5755e4",
"db_currency_id": "b9e81ad7-0e43-4d30-b5c9-a5d7cb4cb4f2",
"db_language_id": "033b43ac-3f92-481b-b22d-2ac7d94c146f",
"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-01T01:34:11.5789595+00:00"
},
"modified_dateutc": "2026-03-01T01:34:11.5789595+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1f755777-e370-4edb-9963-aa0274698b02",
"date_reported_by_company": "2026-03-01T01:34:11.5789595+00:00",
"id2": 36,
"company_id": "3f72c65b-1240-44a7-b2b9-33f3d155f5cf",
"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": "d315d68a-29ca-4333-8db8-6f84cb53b66a",
"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-01T01:34:11.5789595+00:00"
},
"work_instruction_details_id": "be725d38-aca3-47db-9ccc-34d7b2a1d9d5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3d444341-7d4a-4534-bda6-0cf80567860a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0dd907e1-f857-4df5-b060-7d56473a50ff",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-01T01:34:11.5789595+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": "62ecf8ab-1672-4530-aa95-f88667a10d64",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-01T01:34:11.5789595+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.