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": "e51ac211-0caf-4d4c-9429-4a5f2d4e41fc",
"jobs_id": "4bc76d07-60c3-4a48-a7de-3a1cf687de0e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5ae1900d-66e1-4c78-8a15-5b017a376607",
"_parent_id": "ca439c99-5582-46e7-9b58-5fae5296fcc2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8b94b087-2d47-4724-9849-62a3f9989949",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0b8a009c-d01f-497f-a10d-1bf85bd29a62",
"_parent_id": "0c0ef6d7-25e1-4836-af80-0543f390cd90",
"root_parent_id": "4f185a94-310c-4174-b2b6-2308cfbab557",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2ad6cf4a-d297-4264-bc75-938d44eb317e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c9b23be9-2a1d-4e3c-b9bb-a4bb6392485b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "52d7cb70-06c6-4813-868f-bbc207e6a36e",
"_parent_code": "sample string 6",
"sales_organization_id": "39535649-c2fd-4708-bbbe-d118ddb92418",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a9f1c768-c213-471e-aaf4-52b9971fe80e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bfc6bc2b-e3fd-4e2f-b310-207e2de4f37d",
"db_currency_id": "ae456f92-b89f-4199-be85-c64b5b7f4186",
"db_language_id": "dd5cb864-bcd2-421d-951a-a16c2eaff3e8",
"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-11T06:18:28.6562738+00:00"
},
"modified_dateutc": "2026-07-11T06:18:28.6562738+00:00"
},
"equipment_model_id": "755801ad-307a-48c2-97ea-4889af6e54df",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "38ef4bb9-b2bb-4e46-a1b8-b57f8c6c2499",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3817b67f-6727-45b1-84be-f7e4751a0b96",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a1fe1b0c-d0f9-45d5-87cb-0a3b0391d27f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "35791557-ecdc-4149-af20-029ecc73fc74",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a9f1c768-c213-471e-aaf4-52b9971fe80e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bfc6bc2b-e3fd-4e2f-b310-207e2de4f37d",
"db_currency_id": "ae456f92-b89f-4199-be85-c64b5b7f4186",
"db_language_id": "dd5cb864-bcd2-421d-951a-a16c2eaff3e8",
"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-11T06:18:28.6562738+00:00"
},
"modified_dateutc": "2026-07-11T06:18:28.6562738+00:00"
},
"equipment_family_id": "1d79f5b7-6a47-44d5-9623-4b7449c3d683",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c9b23be9-2a1d-4e3c-b9bb-a4bb6392485b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "52d7cb70-06c6-4813-868f-bbc207e6a36e",
"_parent_code": "sample string 6",
"sales_organization_id": "39535649-c2fd-4708-bbbe-d118ddb92418",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a9f1c768-c213-471e-aaf4-52b9971fe80e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bfc6bc2b-e3fd-4e2f-b310-207e2de4f37d",
"db_currency_id": "ae456f92-b89f-4199-be85-c64b5b7f4186",
"db_language_id": "dd5cb864-bcd2-421d-951a-a16c2eaff3e8",
"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-11T06:18:28.6562738+00:00"
},
"modified_dateutc": "2026-07-11T06:18:28.6562738+00:00"
},
"date_in_production_since": "2026-07-11T06:18:28.6562738+00:00",
"date_out_of_production_since": "2026-07-11T06:18:28.6562738+00:00",
"date_end_support": "2026-07-11T06:18:28.6562738+00:00",
"sales_organization_id": "8a382d46-8030-4c44-84c7-de13abed911f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a9f1c768-c213-471e-aaf4-52b9971fe80e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bfc6bc2b-e3fd-4e2f-b310-207e2de4f37d",
"db_currency_id": "ae456f92-b89f-4199-be85-c64b5b7f4186",
"db_language_id": "dd5cb864-bcd2-421d-951a-a16c2eaff3e8",
"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-11T06:18:28.6562738+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-11T06:18:28.6562738+00:00"
},
"project_status_id": "93510822-cb16-40cd-b53b-d954290b630d",
"project_status_code": "sample string 10",
"project_status": {
"id": "705c37a5-635a-4774-b212-af5f4a7f1d07",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5a9ba276-5c8d-48a5-a88d-4feabcb86eb4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a9f1c768-c213-471e-aaf4-52b9971fe80e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bfc6bc2b-e3fd-4e2f-b310-207e2de4f37d",
"db_currency_id": "ae456f92-b89f-4199-be85-c64b5b7f4186",
"db_language_id": "dd5cb864-bcd2-421d-951a-a16c2eaff3e8",
"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-11T06:18:28.6562738+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-11T06:18:28.6562738+00:00"
},
"company_id": "550dd1a4-b077-4ac1-8baf-ee545be8060c",
"company_code": "sample string 12",
"db_address_id": "c567d73c-4ba8-4141-b7dc-93b039020b79",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0622b6ec-227e-4a87-a22e-533bf7af6618",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "144e216a-70e1-437b-825b-763f84cbc4d8",
"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-11T06:18:28.6562738+00:00",
"date_create": "2026-07-11T06:18:28.6562738+00:00",
"date_update": "2026-07-11T06:18:28.6562738+00:00",
"updated_by_user_id": "f6c7abd6-dd69-4457-a5c4-f9f0307e535d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-11T06:18:28.6562738+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-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-11T06:18:28.6562738+00:00",
"date_last_job": "2026-07-11T06:18:28.6562738+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-11T06:18:28.6562738+00:00",
"modified_dateutc": "2026-07-11T06:18:28.6562738+00:00",
"is_mobile_installation": true
},
"job_type_id": "b3796e4e-5053-44bb-a395-116fb96b32fc",
"job_type_code": "sample string 7",
"job_type": {
"id": "5eeba0ed-7cb0-46e0-bb71-22d6c5796215",
"name": "sample string 2",
"sales_organization_id": "0d5bf20f-be7a-4e2d-ac9b-0bc9766f3080",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-11T06:18:28.6562738+00:00",
"code": "sample string 7"
},
"job_priority_id": "42dc09d8-52e0-4e70-87c6-8f3cfec6e304",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1c01d444-b6a4-48b9-ae2e-78dd685d1ffe",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c987b806-6104-408a-8702-b3f5e5578c1c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a9f1c768-c213-471e-aaf4-52b9971fe80e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bfc6bc2b-e3fd-4e2f-b310-207e2de4f37d",
"db_currency_id": "ae456f92-b89f-4199-be85-c64b5b7f4186",
"db_language_id": "dd5cb864-bcd2-421d-951a-a16c2eaff3e8",
"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-11T06:18:28.6562738+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-11T06:18:28.6562738+00:00"
},
"job_status_id": "f4c4c858-3a36-4f80-aad0-3e34b3c877eb",
"job_status_code": "sample string 11",
"db_address_id": "403dcf44-05b8-40a2-9df8-2d566403c588",
"contact_id": "eb8bdd66-5feb-4bae-b2ce-6c8c430272ea",
"requested_by_company_id": "0391146c-c11a-46c7-8e89-311e6469a3dc",
"requested_by_contact_id": "cae5124b-db34-4c64-834b-5432022d6369",
"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-11T06:18:28.6562738+00:00",
"due_date": "2026-07-11T06:18:28.6562738+00:00",
"date_create": "2026-07-11T06:18:28.6562738+00:00",
"date_update": "2026-07-11T06:18:28.6562738+00:00",
"date_closed": "2026-07-11T06:18:28.6562738+00:00",
"suggested_user_id": "79545fe7-8137-4993-b748-2fe75169ea2c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fd69531b-e7eb-48e3-ae49-00ec0d581b55",
"db_language_id": "31321c42-c4ea-4a21-8f86-59b26e0e7451",
"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-11T06:18:28.6562738+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d0decf68-5321-4239-ad15-523ec53a8408",
"sales_organization": {
"id": "a9f1c768-c213-471e-aaf4-52b9971fe80e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bfc6bc2b-e3fd-4e2f-b310-207e2de4f37d",
"db_currency_id": "ae456f92-b89f-4199-be85-c64b5b7f4186",
"db_language_id": "dd5cb864-bcd2-421d-951a-a16c2eaff3e8",
"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-11T06:18:28.6562738+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7842f0be-13f1-4fde-882a-1f4044631267",
"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": "721090c3-06db-4e8d-8408-a6e9f24d5af2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-11T06:18:28.6562738+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "132462f5-e618-4d82-9068-8c62b01d6935"
},
"suggested_date_start": "2026-07-11T06:18:28.6562738+00:00",
"skill_id": "9404d1d6-55d7-428d-992f-80994a400bb5",
"skill_code": "sample string 32",
"skill": {
"id": "9eb8e4c9-24cd-4dfc-8ef8-2d91ddbec73a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7cb4b93e-37e9-4d2d-89af-a0ce7595956f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a9f1c768-c213-471e-aaf4-52b9971fe80e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bfc6bc2b-e3fd-4e2f-b310-207e2de4f37d",
"db_currency_id": "ae456f92-b89f-4199-be85-c64b5b7f4186",
"db_language_id": "dd5cb864-bcd2-421d-951a-a16c2eaff3e8",
"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-11T06:18:28.6562738+00:00"
},
"modified_dateutc": "2026-07-11T06:18:28.6562738+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "bbba814b-5d6a-441d-865b-2905c9ddd73c",
"date_reported_by_company": "2026-07-11T06:18:28.6562738+00:00",
"id2": 36,
"company_id": "f46ca5d9-8ba9-4497-b411-dc89535c127d",
"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": "ab8c6018-9bc6-4dc5-82d9-50337b114dca",
"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-11T06:18:28.6562738+00:00"
},
"work_instruction_details_id": "03f169da-52a2-4046-9902-6278d1def839",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "96b50755-ea0f-4193-8c52-1c01e65464cf",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a5fc50f2-760c-475a-8568-463612f1abcc",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-11T06:18:28.6562738+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": "ac6469e0-5126-4cb0-a5f8-bc6d317dbe4b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-11T06:18:28.6562738+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.