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": "16e47924-b51a-467b-ab30-1a9567c66532",
"jobs_id": "0e7d0e8b-84d2-4ff7-84b6-f7fbb61f283d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e358e0b2-36d3-400e-bc85-83a977dea1d5",
"_parent_id": "6798c1c1-da10-4008-ab12-2e73b561b35a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "cb1f534b-f9b3-4744-8f9e-65b84d9a309f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "226fae4a-13e5-426c-bce3-ce2631ad3ac7",
"_parent_id": "3c2205d3-9da3-46f4-9793-c73bb4350d6f",
"root_parent_id": "da5a60ad-58be-49f0-93e6-f280b7dd206b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a170af83-1283-4f5d-b411-d8a43c95858b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0fb7fcca-bead-48aa-8d60-21e133d6773d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9ffc456e-e2ba-41f2-8094-f94261d2c6b5",
"_parent_code": "sample string 6",
"sales_organization_id": "f9b7fe80-820f-41bd-b8f5-4e139130a91f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a4f794fd-9411-4a8d-9ab4-aad67754d681",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78d19c96-cb38-4b42-921e-ddc683290fc9",
"db_currency_id": "f9428462-7341-41cb-8188-02fe7fe4fe8f",
"db_language_id": "c10a7c56-1e91-4202-8283-e8b7e3bcbac3",
"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-29T21:37:20.8269983+00:00"
},
"modified_dateutc": "2026-01-29T21:37:20.8269983+00:00"
},
"equipment_model_id": "8c8795cd-7ce7-450a-81df-0448e9e1d154",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2f4fd460-425d-400d-b66b-429463a4abb9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "11570f0f-3408-4702-89f7-71acf2553fe2",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5fac7e96-4df8-4c16-943c-7b207c7432a7",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b29bcf89-62d8-4d02-adda-eb1010b48ab9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a4f794fd-9411-4a8d-9ab4-aad67754d681",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78d19c96-cb38-4b42-921e-ddc683290fc9",
"db_currency_id": "f9428462-7341-41cb-8188-02fe7fe4fe8f",
"db_language_id": "c10a7c56-1e91-4202-8283-e8b7e3bcbac3",
"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-29T21:37:20.8269983+00:00"
},
"modified_dateutc": "2026-01-29T21:37:20.8269983+00:00"
},
"equipment_family_id": "ece9eb3b-d5ca-4a09-8796-d9c51ab830f5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0fb7fcca-bead-48aa-8d60-21e133d6773d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9ffc456e-e2ba-41f2-8094-f94261d2c6b5",
"_parent_code": "sample string 6",
"sales_organization_id": "f9b7fe80-820f-41bd-b8f5-4e139130a91f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a4f794fd-9411-4a8d-9ab4-aad67754d681",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78d19c96-cb38-4b42-921e-ddc683290fc9",
"db_currency_id": "f9428462-7341-41cb-8188-02fe7fe4fe8f",
"db_language_id": "c10a7c56-1e91-4202-8283-e8b7e3bcbac3",
"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-29T21:37:20.8269983+00:00"
},
"modified_dateutc": "2026-01-29T21:37:20.8269983+00:00"
},
"date_in_production_since": "2026-01-29T21:37:20.8269983+00:00",
"date_out_of_production_since": "2026-01-29T21:37:20.8269983+00:00",
"date_end_support": "2026-01-29T21:37:20.8269983+00:00",
"sales_organization_id": "d19365ad-dd74-4714-9965-be7c0df28203",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a4f794fd-9411-4a8d-9ab4-aad67754d681",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78d19c96-cb38-4b42-921e-ddc683290fc9",
"db_currency_id": "f9428462-7341-41cb-8188-02fe7fe4fe8f",
"db_language_id": "c10a7c56-1e91-4202-8283-e8b7e3bcbac3",
"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-29T21:37:20.8269983+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-29T21:37:20.8426242+00:00"
},
"project_status_id": "d6667747-8d0e-46de-a264-86d6591897c9",
"project_status_code": "sample string 10",
"project_status": {
"id": "44ee6d4c-418e-4d24-b73a-72125b2ba5ca",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3b0fca9d-1aa7-436f-bb3b-bb29a7c5c693",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a4f794fd-9411-4a8d-9ab4-aad67754d681",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78d19c96-cb38-4b42-921e-ddc683290fc9",
"db_currency_id": "f9428462-7341-41cb-8188-02fe7fe4fe8f",
"db_language_id": "c10a7c56-1e91-4202-8283-e8b7e3bcbac3",
"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-29T21:37:20.8269983+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-29T21:37:20.8426242+00:00"
},
"company_id": "1984ace1-21dc-4380-9c18-2b2f0ae6e155",
"company_code": "sample string 12",
"db_address_id": "7ef16a2f-efc0-4bed-9445-9d81c9e62db5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "82df1007-4107-45e0-8016-b80fe4c1c730",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a7dc69cc-e8f4-492e-8943-65073c72e0fd",
"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-29T21:37:20.8426242+00:00",
"date_create": "2026-01-29T21:37:20.8426242+00:00",
"date_update": "2026-01-29T21:37:20.8426242+00:00",
"updated_by_user_id": "9bf5a3a0-11f0-4a13-949e-56334e85f1f6",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-29T21:37:20.8426242+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-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-29T21:37:20.8426242+00:00",
"date_last_job": "2026-01-29T21:37:20.8426242+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-29T21:37:20.8426242+00:00",
"modified_dateutc": "2026-01-29T21:37:20.8426242+00:00",
"is_mobile_installation": true
},
"job_type_id": "9093924b-22c4-4c8b-a092-758a6de6a002",
"job_type_code": "sample string 7",
"job_type": {
"id": "4109eb26-120c-4043-bdbf-a56719d04216",
"name": "sample string 2",
"sales_organization_id": "799911b0-fa28-4e6b-a3f8-268b9bdae809",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-29T21:37:20.8426242+00:00",
"code": "sample string 7"
},
"job_priority_id": "57a29bad-84c6-4b14-9bf8-358960b9aea6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "21e627e9-0662-4591-ba44-ad4460a75cdb",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b32da034-a172-4f6f-9e68-346930b8e668",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a4f794fd-9411-4a8d-9ab4-aad67754d681",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78d19c96-cb38-4b42-921e-ddc683290fc9",
"db_currency_id": "f9428462-7341-41cb-8188-02fe7fe4fe8f",
"db_language_id": "c10a7c56-1e91-4202-8283-e8b7e3bcbac3",
"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-29T21:37:20.8269983+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-29T21:37:20.8426242+00:00"
},
"job_status_id": "18b82fc9-b00d-4abf-960d-cb5c552c217e",
"job_status_code": "sample string 11",
"db_address_id": "6707e7aa-8acb-4b0b-8cb8-4350e9dc4c24",
"contact_id": "ef1ccabc-ecc2-4eed-892d-9565a238a71e",
"requested_by_company_id": "f4109eb4-52c4-4b91-b0e7-7edb8921459f",
"requested_by_contact_id": "d80ba03b-37b5-49c7-941b-a2085cd8cf95",
"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-29T21:37:20.8426242+00:00",
"due_date": "2026-01-29T21:37:20.8426242+00:00",
"date_create": "2026-01-29T21:37:20.8426242+00:00",
"date_update": "2026-01-29T21:37:20.8426242+00:00",
"date_closed": "2026-01-29T21:37:20.8426242+00:00",
"suggested_user_id": "bc2a3437-6e15-4243-9ab6-9184a0eaae44",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "eaac78ef-37fd-436e-b753-d5b569e0f00b",
"db_language_id": "9a79f4a4-a378-4d9b-96ca-71f534799c11",
"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-29T21:37:20.8426242+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e9040e34-b196-4bb9-a225-12769cb665e8",
"sales_organization": {
"id": "a4f794fd-9411-4a8d-9ab4-aad67754d681",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78d19c96-cb38-4b42-921e-ddc683290fc9",
"db_currency_id": "f9428462-7341-41cb-8188-02fe7fe4fe8f",
"db_language_id": "c10a7c56-1e91-4202-8283-e8b7e3bcbac3",
"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-29T21:37:20.8269983+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5ee364d2-79d8-49b1-989a-81d9f94be3c0",
"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": "b6f40640-f6d2-412f-959e-0987bb6c35fb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-29T21:37:20.8426242+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1748b836-14cd-4b32-a58d-20ce021fd6c8"
},
"suggested_date_start": "2026-01-29T21:37:20.8426242+00:00",
"skill_id": "433c16bf-995c-488f-af0b-ae9e85921e10",
"skill_code": "sample string 32",
"skill": {
"id": "4474ad6f-5d15-452c-93d1-725f285342f8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7a8d220b-0fdb-4fc0-ac1b-36564d14e8fd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a4f794fd-9411-4a8d-9ab4-aad67754d681",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78d19c96-cb38-4b42-921e-ddc683290fc9",
"db_currency_id": "f9428462-7341-41cb-8188-02fe7fe4fe8f",
"db_language_id": "c10a7c56-1e91-4202-8283-e8b7e3bcbac3",
"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-29T21:37:20.8269983+00:00"
},
"modified_dateutc": "2026-01-29T21:37:20.8426242+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f13c023b-3dd2-4c72-8913-1bdaa37caaa5",
"date_reported_by_company": "2026-01-29T21:37:20.8426242+00:00",
"id2": 36,
"company_id": "612409f1-aeb1-4d7d-81b2-74506271a907",
"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": "697ab63d-5264-4981-ad98-3aa04e954b83",
"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-29T21:37:20.8426242+00:00"
},
"work_instruction_details_id": "52ef2bdf-1961-4bff-b957-4fff89fbcd49",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7c66f064-b9b5-4d27-b406-5c8542e0f8ff",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "48cb5ebe-9ed8-4317-beae-a873fd2146aa",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-29T21:37:20.8426242+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": "1967f3af-91de-4ad7-99f6-7dcbf10e21ee",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-29T21:37:20.8426242+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.