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": "cfddae37-e9f5-4465-99c0-7fac5e4f2cc1",
"jobs_id": "a16ae300-8968-4cfe-a568-94c7bcab70ff",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "538678fd-db13-4990-9a1c-2d6e6f6c61ce",
"_parent_id": "e666e9ba-330f-4fec-8102-61af4b8a21cf",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4dbae456-b914-4f6d-b3e2-9c37cc53f076",
"project_reference_back_office": "sample string 5",
"project": {
"id": "329fa96f-526d-40ec-ba47-a61fd1b4def9",
"_parent_id": "b16d7ef5-0d14-4e56-b3c0-20adb210edd4",
"root_parent_id": "dbad76bb-c394-49ac-ac0f-3835829c9f45",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0066a52c-5f58-4a5e-82bc-f88061a80d48",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1e6ccdc2-8704-4986-8977-9e2f7729613d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5459b2bd-f195-42ee-9633-2128a11a3405",
"_parent_code": "sample string 6",
"sales_organization_id": "76a6bff1-54c3-42c9-954b-c92018064e16",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9a31f010-2c36-43ce-97f7-3df25f2077da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e7336ca-3bc3-42d4-9231-1b35223447ea",
"db_currency_id": "795f29ab-3fd1-40ee-bfd0-989d1031fee2",
"db_language_id": "7cd6e9da-63f8-48cf-849e-5e5860571a4b",
"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-05-23T02:42:31.8003993+00:00"
},
"modified_dateutc": "2026-05-23T02:42:31.8003993+00:00"
},
"equipment_model_id": "abb8f407-343e-4a08-977d-b2a582bcb426",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "992b8611-d7e6-49e2-a1d6-f5aa42a0923e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1c2335f8-d3e2-402a-97a3-9c5ce8b4491e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9b1364e4-0f3d-4587-bc45-48e069c0cec8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5d8ece1a-e134-43f1-8429-fed1ed02bd94",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9a31f010-2c36-43ce-97f7-3df25f2077da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e7336ca-3bc3-42d4-9231-1b35223447ea",
"db_currency_id": "795f29ab-3fd1-40ee-bfd0-989d1031fee2",
"db_language_id": "7cd6e9da-63f8-48cf-849e-5e5860571a4b",
"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-05-23T02:42:31.8003993+00:00"
},
"modified_dateutc": "2026-05-23T02:42:31.8003993+00:00"
},
"equipment_family_id": "1594a6b9-e7ad-4cc7-b452-7e8995781097",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1e6ccdc2-8704-4986-8977-9e2f7729613d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5459b2bd-f195-42ee-9633-2128a11a3405",
"_parent_code": "sample string 6",
"sales_organization_id": "76a6bff1-54c3-42c9-954b-c92018064e16",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9a31f010-2c36-43ce-97f7-3df25f2077da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e7336ca-3bc3-42d4-9231-1b35223447ea",
"db_currency_id": "795f29ab-3fd1-40ee-bfd0-989d1031fee2",
"db_language_id": "7cd6e9da-63f8-48cf-849e-5e5860571a4b",
"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-05-23T02:42:31.8003993+00:00"
},
"modified_dateutc": "2026-05-23T02:42:31.8003993+00:00"
},
"date_in_production_since": "2026-05-23T02:42:31.8003993+00:00",
"date_out_of_production_since": "2026-05-23T02:42:31.8003993+00:00",
"date_end_support": "2026-05-23T02:42:31.8003993+00:00",
"sales_organization_id": "e4ec6ff6-bab8-4605-9790-8ec6a3daf930",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9a31f010-2c36-43ce-97f7-3df25f2077da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e7336ca-3bc3-42d4-9231-1b35223447ea",
"db_currency_id": "795f29ab-3fd1-40ee-bfd0-989d1031fee2",
"db_language_id": "7cd6e9da-63f8-48cf-849e-5e5860571a4b",
"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-05-23T02:42:31.8003993+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-05-23T02:42:31.8003993+00:00"
},
"project_status_id": "9f0adec1-3f96-4dbe-a8bc-bfc1e9ba68ce",
"project_status_code": "sample string 10",
"project_status": {
"id": "7ea69761-9b84-46df-8191-147a8e0ac0df",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "037f890d-4a83-42f8-a8f5-85d9e3e27260",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9a31f010-2c36-43ce-97f7-3df25f2077da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e7336ca-3bc3-42d4-9231-1b35223447ea",
"db_currency_id": "795f29ab-3fd1-40ee-bfd0-989d1031fee2",
"db_language_id": "7cd6e9da-63f8-48cf-849e-5e5860571a4b",
"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-05-23T02:42:31.8003993+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-23T02:42:31.8003993+00:00"
},
"company_id": "126a7f91-bcf8-4c43-a181-cdca5c179024",
"company_code": "sample string 12",
"db_address_id": "74b2e960-7d96-468c-9d2c-dfa490d8af93",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "67b4c324-1370-4912-977b-0dea06cb6d23",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "db86aa03-88ea-4e68-b9e5-f3f8733ae1a0",
"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-05-23T02:42:31.8003993+00:00",
"date_create": "2026-05-23T02:42:31.8003993+00:00",
"date_update": "2026-05-23T02:42:31.8003993+00:00",
"updated_by_user_id": "2b11220e-d8d7-49dd-9425-7859f228590b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-23T02:42:31.8003993+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-05-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-23T02:42:31.8003993+00:00",
"date_last_job": "2026-05-23T02:42:31.8003993+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-23T02:42:31.8003993+00:00",
"modified_dateutc": "2026-05-23T02:42:31.8003993+00:00",
"is_mobile_installation": true
},
"job_type_id": "7865159e-8e76-4320-a571-079c0341a7df",
"job_type_code": "sample string 7",
"job_type": {
"id": "fde65f7b-9ef1-4b9f-bac6-ff3e080df640",
"name": "sample string 2",
"sales_organization_id": "829b88db-23c3-49ab-8d13-6dddaa2573f6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-23T02:42:31.8003993+00:00",
"code": "sample string 7"
},
"job_priority_id": "b6225b4b-599a-43da-8ce2-552c3cb09ccc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5227b3d4-30a0-410f-8b73-eaf3d5ec87b2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "eaf3d8bd-b4a2-4ee7-a4d2-c688175a2c24",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9a31f010-2c36-43ce-97f7-3df25f2077da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e7336ca-3bc3-42d4-9231-1b35223447ea",
"db_currency_id": "795f29ab-3fd1-40ee-bfd0-989d1031fee2",
"db_language_id": "7cd6e9da-63f8-48cf-849e-5e5860571a4b",
"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-05-23T02:42:31.8003993+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-23T02:42:31.8003993+00:00"
},
"job_status_id": "a7ea69aa-4c1d-4609-88a5-4f605048539f",
"job_status_code": "sample string 11",
"db_address_id": "12a6f19a-2d5a-4d68-923a-8654abcb8fca",
"contact_id": "6e795752-c30e-41e5-b00f-34e851b57e50",
"requested_by_company_id": "86c9aada-5851-4ef9-8656-f01235940203",
"requested_by_contact_id": "99fe7fd1-69d8-4873-a2d4-634c1cbc5574",
"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-05-23T02:42:31.8003993+00:00",
"due_date": "2026-05-23T02:42:31.8003993+00:00",
"date_create": "2026-05-23T02:42:31.8003993+00:00",
"date_update": "2026-05-23T02:42:31.8003993+00:00",
"date_closed": "2026-05-23T02:42:31.8003993+00:00",
"suggested_user_id": "b2bb63fa-ecf8-4388-a9de-c8c2f3a8eda7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "183d652d-80c1-4983-a6d9-d45a7854dfe4",
"db_language_id": "49924d98-0a28-4b4b-8be3-5801fc03fdb4",
"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-05-23T02:42:31.8003993+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "22d0c56a-711f-497a-ab64-df212c8e9bd7",
"sales_organization": {
"id": "9a31f010-2c36-43ce-97f7-3df25f2077da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e7336ca-3bc3-42d4-9231-1b35223447ea",
"db_currency_id": "795f29ab-3fd1-40ee-bfd0-989d1031fee2",
"db_language_id": "7cd6e9da-63f8-48cf-849e-5e5860571a4b",
"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-05-23T02:42:31.8003993+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "77aa77f4-bb64-45b9-aa70-7bb31aea6210",
"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": "d766e938-92cd-4071-a67c-6d3b100962b7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-23T02:42:31.8003993+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8facb605-c6b9-4967-986e-d1016ae3337c"
},
"suggested_date_start": "2026-05-23T02:42:31.8003993+00:00",
"skill_id": "c75da4a1-9202-4db8-821f-5b57fc699d1d",
"skill_code": "sample string 32",
"skill": {
"id": "0c9f2e21-ac86-4f69-befc-318b506c02fe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7ffb156d-2046-45a1-8645-33d055059262",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9a31f010-2c36-43ce-97f7-3df25f2077da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e7336ca-3bc3-42d4-9231-1b35223447ea",
"db_currency_id": "795f29ab-3fd1-40ee-bfd0-989d1031fee2",
"db_language_id": "7cd6e9da-63f8-48cf-849e-5e5860571a4b",
"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-05-23T02:42:31.8003993+00:00"
},
"modified_dateutc": "2026-05-23T02:42:31.8003993+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "41d23a77-0363-4af1-bdd1-a504f494132c",
"date_reported_by_company": "2026-05-23T02:42:31.8003993+00:00",
"id2": 36,
"company_id": "6252706a-f588-4815-9329-d3a839f90571",
"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": "4524ec3f-3587-4560-93fd-369768e3446a",
"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-05-23T02:42:31.8003993+00:00"
},
"work_instruction_details_id": "09345f18-7819-4ffe-951a-23ae9c2e5e6a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3006ceac-1607-4814-a0d8-5f01953ad09a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2ea1182c-68a6-4382-90ab-6581695c0909",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-23T02:42:31.8003993+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": "036395e7-b2f3-47ef-93b4-73d5128c32c1",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-23T02:42:31.8003993+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.