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": "41c232a1-ebe2-4366-925e-630b89dd8359",
"jobs_id": "6139526c-9b5c-4c4d-aa0a-5a9b2f2e54d1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "43d6e2f3-ddef-4b1c-a3c7-4758057c9a38",
"_parent_id": "0752e461-b4bd-4d57-b2a6-9ed8beee92c4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "481627ab-009c-49fe-ae56-9ff228401dfc",
"project_reference_back_office": "sample string 5",
"project": {
"id": "cc137435-fc95-4353-bd7b-6be104505a4d",
"_parent_id": "e3ca8c10-33e1-46e0-af82-3eecc61738e7",
"root_parent_id": "c197fc3b-0be0-475b-ba23-b14708bc5f57",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7eb296df-02c4-4c06-9a8b-58bcc757169c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0d5e9772-0fe4-4998-b318-a4bfb8b8ae4b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0f2d4059-6a61-439c-8037-feea97672004",
"_parent_code": "sample string 6",
"sales_organization_id": "c3c343f3-8fff-4b34-8d69-ac81df1f18a1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5d9de69f-87b3-4254-855c-94f4eec9cae3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a521400d-99d0-4bab-aa5f-07b3ab3a684a",
"db_currency_id": "90a291ca-2a9f-4ec6-b1df-9adcbb11fa53",
"db_language_id": "4aa6babd-aeb0-417d-b71c-43d851972c7c",
"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-04-18T12:39:49.7467179+00:00"
},
"modified_dateutc": "2026-04-18T12:39:49.7623435+00:00"
},
"equipment_model_id": "f879c6bc-76a7-427d-bb90-8844c0b6255f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "68c0560b-815e-48c8-aeb9-5f1cb357d4f8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "36618406-9d78-4652-821e-c1bf76afc9ab",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0e67067b-4588-4108-b967-714f8a21653a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "faa1a807-3224-4be6-80fd-100a9b0615db",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5d9de69f-87b3-4254-855c-94f4eec9cae3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a521400d-99d0-4bab-aa5f-07b3ab3a684a",
"db_currency_id": "90a291ca-2a9f-4ec6-b1df-9adcbb11fa53",
"db_language_id": "4aa6babd-aeb0-417d-b71c-43d851972c7c",
"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-04-18T12:39:49.7467179+00:00"
},
"modified_dateutc": "2026-04-18T12:39:49.7623435+00:00"
},
"equipment_family_id": "2f4cae6d-5e0a-4ab5-9caa-e4d947ec470b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0d5e9772-0fe4-4998-b318-a4bfb8b8ae4b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0f2d4059-6a61-439c-8037-feea97672004",
"_parent_code": "sample string 6",
"sales_organization_id": "c3c343f3-8fff-4b34-8d69-ac81df1f18a1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5d9de69f-87b3-4254-855c-94f4eec9cae3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a521400d-99d0-4bab-aa5f-07b3ab3a684a",
"db_currency_id": "90a291ca-2a9f-4ec6-b1df-9adcbb11fa53",
"db_language_id": "4aa6babd-aeb0-417d-b71c-43d851972c7c",
"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-04-18T12:39:49.7467179+00:00"
},
"modified_dateutc": "2026-04-18T12:39:49.7623435+00:00"
},
"date_in_production_since": "2026-04-18T12:39:49.7623435+00:00",
"date_out_of_production_since": "2026-04-18T12:39:49.7623435+00:00",
"date_end_support": "2026-04-18T12:39:49.7623435+00:00",
"sales_organization_id": "c6a56af2-0e02-4df8-be85-9a5c7e29c698",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5d9de69f-87b3-4254-855c-94f4eec9cae3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a521400d-99d0-4bab-aa5f-07b3ab3a684a",
"db_currency_id": "90a291ca-2a9f-4ec6-b1df-9adcbb11fa53",
"db_language_id": "4aa6babd-aeb0-417d-b71c-43d851972c7c",
"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-04-18T12:39:49.7467179+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-04-18T12:39:49.7623435+00:00"
},
"project_status_id": "1c49d6f8-5a90-452b-a373-4eb521f41e68",
"project_status_code": "sample string 10",
"project_status": {
"id": "646f1560-fc38-4f12-a93f-70fb3b668013",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "32e203fa-ae58-4c95-af14-793903725af7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5d9de69f-87b3-4254-855c-94f4eec9cae3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a521400d-99d0-4bab-aa5f-07b3ab3a684a",
"db_currency_id": "90a291ca-2a9f-4ec6-b1df-9adcbb11fa53",
"db_language_id": "4aa6babd-aeb0-417d-b71c-43d851972c7c",
"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-04-18T12:39:49.7467179+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-18T12:39:49.7623435+00:00"
},
"company_id": "2204f502-4ed9-4b47-a690-3616f57e4b65",
"company_code": "sample string 12",
"db_address_id": "1a0cfb56-7434-495a-b835-1c3938a5e6e1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c39b4ec2-05f3-4f36-a7fb-9ab4789865d6",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7152ef7d-b975-4aae-87bd-daf7a55b7c10",
"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-04-18T12:39:49.7623435+00:00",
"date_create": "2026-04-18T12:39:49.7623435+00:00",
"date_update": "2026-04-18T12:39:49.7623435+00:00",
"updated_by_user_id": "a6cc2f6d-f4b3-471f-a546-61c5747218be",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-18T12:39:49.7623435+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-04-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-18T12:39:49.7623435+00:00",
"date_last_job": "2026-04-18T12:39:49.7623435+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-18T12:39:49.7623435+00:00",
"modified_dateutc": "2026-04-18T12:39:49.7623435+00:00",
"is_mobile_installation": true
},
"job_type_id": "055ee13c-a469-401f-9087-0ee02a13c490",
"job_type_code": "sample string 7",
"job_type": {
"id": "4b56c439-3720-4b90-a164-e08a9a1d7fa0",
"name": "sample string 2",
"sales_organization_id": "780c85ce-4ff3-4e74-a1d4-d2034a300d79",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-18T12:39:49.7623435+00:00",
"code": "sample string 7"
},
"job_priority_id": "a9e97218-8bc5-488b-b4fd-128305199fe4",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "cfc60df7-fe67-4acc-99c5-e555ead7c994",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "291e66e3-70bb-45d0-983f-baacad010132",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5d9de69f-87b3-4254-855c-94f4eec9cae3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a521400d-99d0-4bab-aa5f-07b3ab3a684a",
"db_currency_id": "90a291ca-2a9f-4ec6-b1df-9adcbb11fa53",
"db_language_id": "4aa6babd-aeb0-417d-b71c-43d851972c7c",
"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-04-18T12:39:49.7467179+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-18T12:39:49.7623435+00:00"
},
"job_status_id": "83c41a4a-689e-404a-a810-0568e1c33245",
"job_status_code": "sample string 11",
"db_address_id": "afd23487-6c5f-48b5-8e42-d92627b5a564",
"contact_id": "6e8728a1-c5ec-4452-a7a3-c93b588ef9e0",
"requested_by_company_id": "de6d0c70-7c7c-4598-9333-21d36ad9306a",
"requested_by_contact_id": "505ce1bd-c24e-48d1-b0f8-f3dc8cc75422",
"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-04-18T12:39:49.7623435+00:00",
"due_date": "2026-04-18T12:39:49.7623435+00:00",
"date_create": "2026-04-18T12:39:49.7623435+00:00",
"date_update": "2026-04-18T12:39:49.7623435+00:00",
"date_closed": "2026-04-18T12:39:49.7623435+00:00",
"suggested_user_id": "8550f7e2-e7f0-429e-9f01-cbe062315aaf",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d5d3aa3c-a35d-4c69-80a9-755765f2392b",
"db_language_id": "16bd8f84-d8ab-4088-ad85-19aa927f0e69",
"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-04-18T12:39:49.7623435+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "fb24cc1f-1a15-45b6-9960-98943aaf88a8",
"sales_organization": {
"id": "5d9de69f-87b3-4254-855c-94f4eec9cae3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a521400d-99d0-4bab-aa5f-07b3ab3a684a",
"db_currency_id": "90a291ca-2a9f-4ec6-b1df-9adcbb11fa53",
"db_language_id": "4aa6babd-aeb0-417d-b71c-43d851972c7c",
"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-04-18T12:39:49.7467179+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2ced02b4-2b00-4927-8d29-cac027aae4b9",
"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": "eabc9d31-6ff7-44e0-8cff-93503859be64",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-18T12:39:49.7623435+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a91790e6-e554-4047-bc64-96d75e5798fd"
},
"suggested_date_start": "2026-04-18T12:39:49.7623435+00:00",
"skill_id": "6543433b-72ff-42dc-9438-c8d11d60e0a6",
"skill_code": "sample string 32",
"skill": {
"id": "bd3ff6e7-529a-4c13-b9c3-92f53380c3e7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "37669592-abaa-46ff-8ce8-b0332ddb7e9a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5d9de69f-87b3-4254-855c-94f4eec9cae3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a521400d-99d0-4bab-aa5f-07b3ab3a684a",
"db_currency_id": "90a291ca-2a9f-4ec6-b1df-9adcbb11fa53",
"db_language_id": "4aa6babd-aeb0-417d-b71c-43d851972c7c",
"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-04-18T12:39:49.7467179+00:00"
},
"modified_dateutc": "2026-04-18T12:39:49.7623435+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a9dc03c7-98cc-4398-b41b-a793cf28bc1e",
"date_reported_by_company": "2026-04-18T12:39:49.7623435+00:00",
"id2": 36,
"company_id": "f26b59d7-15f5-46b0-bdeb-5fdb1e5c6670",
"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": "069b55fe-4841-446b-ba2e-c45d82b61779",
"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-04-18T12:39:49.7623435+00:00"
},
"work_instruction_details_id": "f920f4c8-d45e-43b7-9f96-72603ca469ab",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5d8df48e-c0e3-4962-8e60-24caa885155f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1e5c66c0-2530-4aa1-9543-5d74ad94b87e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-18T12:39:49.7623435+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": "16943263-8b0e-4b09-91f6-fe843ae5a0a8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-18T12:39:49.7623435+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.