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": "f78c1dbb-fb01-4705-8ac7-7f02e00d47de",
"jobs_id": "ecbc7be8-e29a-4b2d-85ae-decd64d79a40",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b9a78cb6-e96c-4c8d-93c9-0f5551c2d455",
"_parent_id": "8b7a3338-2399-41dc-9f9f-39efd9d60314",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "cef14542-50eb-41ba-8112-47630df4886b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4755a708-7c0b-4055-b4d6-48e1667bc9da",
"_parent_id": "094631d8-7714-49d2-8d5a-fd9d5d93f6fa",
"root_parent_id": "efc1a01b-9758-4eb7-8a15-e16398ce3d00",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9b2b6c75-e053-429a-a282-4ec0d048cc0c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b6f9abbc-772a-4b7c-84c5-458c1bfa1613",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7d2e339c-2689-4ffa-ad65-95f3459a60ec",
"_parent_code": "sample string 6",
"sales_organization_id": "47bdd202-c3b9-43b0-9d54-61df591d9b83",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bbc273d9-0562-4b14-ac79-440c99403f93",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ceb1a4ab-5781-4853-b7ff-1f1cafa19e88",
"db_currency_id": "9f12fc51-f412-4326-97f9-45cda891257f",
"db_language_id": "e9afe1b0-4084-4164-ad12-623c6ead13f7",
"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-10-26T10:52:17.6253306+00:00"
},
"modified_dateutc": "2026-10-26T10:52:17.6253306+00:00"
},
"equipment_model_id": "227bad26-637d-4728-aac0-79b1282102c2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "13bdb92d-5131-44f9-aadf-89506ed55cbc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "57d36d22-d213-4d1e-a3a3-367c0947c458",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8dd410bd-c999-48ca-bfb4-1aec3bd73010",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "23cb5644-b4fd-4a7e-af4c-45729b7b583c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bbc273d9-0562-4b14-ac79-440c99403f93",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ceb1a4ab-5781-4853-b7ff-1f1cafa19e88",
"db_currency_id": "9f12fc51-f412-4326-97f9-45cda891257f",
"db_language_id": "e9afe1b0-4084-4164-ad12-623c6ead13f7",
"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-10-26T10:52:17.6253306+00:00"
},
"modified_dateutc": "2026-10-26T10:52:17.6253306+00:00"
},
"equipment_family_id": "b8b5b437-e82e-4efb-b043-c845f39c398a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b6f9abbc-772a-4b7c-84c5-458c1bfa1613",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7d2e339c-2689-4ffa-ad65-95f3459a60ec",
"_parent_code": "sample string 6",
"sales_organization_id": "47bdd202-c3b9-43b0-9d54-61df591d9b83",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bbc273d9-0562-4b14-ac79-440c99403f93",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ceb1a4ab-5781-4853-b7ff-1f1cafa19e88",
"db_currency_id": "9f12fc51-f412-4326-97f9-45cda891257f",
"db_language_id": "e9afe1b0-4084-4164-ad12-623c6ead13f7",
"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-10-26T10:52:17.6253306+00:00"
},
"modified_dateutc": "2026-10-26T10:52:17.6253306+00:00"
},
"date_in_production_since": "2026-10-26T10:52:17.6253306+00:00",
"date_out_of_production_since": "2026-10-26T10:52:17.6253306+00:00",
"date_end_support": "2026-10-26T10:52:17.6253306+00:00",
"sales_organization_id": "ef1aee72-6122-4b01-b40e-a49d2bce0c58",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "bbc273d9-0562-4b14-ac79-440c99403f93",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ceb1a4ab-5781-4853-b7ff-1f1cafa19e88",
"db_currency_id": "9f12fc51-f412-4326-97f9-45cda891257f",
"db_language_id": "e9afe1b0-4084-4164-ad12-623c6ead13f7",
"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-10-26T10:52:17.6253306+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-10-26T10:52:17.6253306+00:00"
},
"project_status_id": "5998e991-ac10-40db-a361-f98645e02fcf",
"project_status_code": "sample string 10",
"project_status": {
"id": "d923843a-b31e-4128-9249-f74953966de7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9dc8b3f3-b18a-4d86-891c-dee74d3e2b6e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bbc273d9-0562-4b14-ac79-440c99403f93",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ceb1a4ab-5781-4853-b7ff-1f1cafa19e88",
"db_currency_id": "9f12fc51-f412-4326-97f9-45cda891257f",
"db_language_id": "e9afe1b0-4084-4164-ad12-623c6ead13f7",
"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-10-26T10:52:17.6253306+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-26T10:52:17.6253306+00:00"
},
"company_id": "95fe5779-f82f-4267-b14d-83242c706b6d",
"company_code": "sample string 12",
"db_address_id": "0e61254d-70db-4866-af46-9260eaae9cc8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f402295f-066d-436a-89cd-db16d89126b1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "65df228c-8d3b-4e95-8fe4-14f7c69b6a5b",
"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-10-26T10:52:17.6253306+00:00",
"date_create": "2026-10-26T10:52:17.6253306+00:00",
"date_update": "2026-10-26T10:52:17.6253306+00:00",
"updated_by_user_id": "ed4d8643-b00e-4dac-bf3e-8712769eb2f2",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-26T10:52:17.6253306+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-10-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-26T10:52:17.6253306+00:00",
"date_last_job": "2026-10-26T10:52:17.6253306+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-26T10:52:17.6253306+00:00",
"modified_dateutc": "2026-10-26T10:52:17.6253306+00:00",
"is_mobile_installation": true
},
"job_type_id": "a8443ce9-b27d-4f1b-a688-2354ea3473a8",
"job_type_code": "sample string 7",
"job_type": {
"id": "566f3043-a1d4-4f13-b715-ed78970906b2",
"name": "sample string 2",
"sales_organization_id": "aa84c5c0-66bf-41db-a14a-164dc29e22b7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-26T10:52:17.6253306+00:00",
"code": "sample string 7"
},
"job_priority_id": "08c8d43d-954f-4778-b750-e5e605aa92ce",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "749c126a-3000-4504-8daf-47321a9fa5e8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a224d522-26bb-4134-b5d4-1ba1f7f5466c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bbc273d9-0562-4b14-ac79-440c99403f93",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ceb1a4ab-5781-4853-b7ff-1f1cafa19e88",
"db_currency_id": "9f12fc51-f412-4326-97f9-45cda891257f",
"db_language_id": "e9afe1b0-4084-4164-ad12-623c6ead13f7",
"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-10-26T10:52:17.6253306+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-26T10:52:17.6253306+00:00"
},
"job_status_id": "3ef56db1-b8ec-46bc-8a17-794fdd6f4cf3",
"job_status_code": "sample string 11",
"db_address_id": "7b874b97-2805-434f-aa4a-beaced1a292d",
"contact_id": "aa42347a-c30c-47a6-808c-35b68cefecd7",
"requested_by_company_id": "09ecbb2f-5d08-4f35-a38f-9cebd0e0d66e",
"requested_by_contact_id": "7608ee96-ab1f-487c-8492-5b82dd4dd163",
"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-10-26T10:52:17.6253306+00:00",
"due_date": "2026-10-26T10:52:17.6253306+00:00",
"date_create": "2026-10-26T10:52:17.6253306+00:00",
"date_update": "2026-10-26T10:52:17.6253306+00:00",
"date_closed": "2026-10-26T10:52:17.6253306+00:00",
"suggested_user_id": "c83222a5-73db-49d6-a7ac-613d718844b9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6204d9eb-9290-49fc-b74c-3937ddb193c5",
"db_language_id": "395e5aba-6aff-44f8-b061-2e5ff0b74b34",
"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-10-26T10:52:17.6253306+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "71d2c164-760c-46c3-8fdc-961ead89c9ec",
"sales_organization": {
"id": "bbc273d9-0562-4b14-ac79-440c99403f93",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ceb1a4ab-5781-4853-b7ff-1f1cafa19e88",
"db_currency_id": "9f12fc51-f412-4326-97f9-45cda891257f",
"db_language_id": "e9afe1b0-4084-4164-ad12-623c6ead13f7",
"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-10-26T10:52:17.6253306+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2d6926ab-f97e-4165-a52d-5c40e8227e81",
"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": "38c63e79-c242-4238-946c-181625bfc0a9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-26T10:52:17.6253306+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "12bd6ecc-bfc8-4d2e-ada4-c2706379f011"
},
"suggested_date_start": "2026-10-26T10:52:17.6253306+00:00",
"skill_id": "eedc4b2a-3c55-4223-89d9-babd07ca5f78",
"skill_code": "sample string 32",
"skill": {
"id": "fd3865f9-e4b3-4078-84b4-60f4bcae9bf4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0f630ea2-a38c-4f0d-ab6d-6d31a5ba0b35",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bbc273d9-0562-4b14-ac79-440c99403f93",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ceb1a4ab-5781-4853-b7ff-1f1cafa19e88",
"db_currency_id": "9f12fc51-f412-4326-97f9-45cda891257f",
"db_language_id": "e9afe1b0-4084-4164-ad12-623c6ead13f7",
"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-10-26T10:52:17.6253306+00:00"
},
"modified_dateutc": "2026-10-26T10:52:17.6253306+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d859f5e9-a8f5-488e-aa4d-94dfdee724ba",
"date_reported_by_company": "2026-10-26T10:52:17.6253306+00:00",
"id2": 36,
"company_id": "e175b3de-1194-46c2-9db0-5a5b01038854",
"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": "5a8b809b-2e99-4c63-9440-eebd18fb797d",
"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-10-26T10:52:17.6438194+00:00"
},
"work_instruction_details_id": "ccc9daa3-dbe8-47ce-9e12-4d7ecd702b73",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7bef3a0d-c684-45e4-84e9-3a05d398a02d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3a7e70a7-67e6-4728-bb54-5055fd38f1c4",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-26T10:52:17.6438194+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": "61bd049e-51b5-4ab9-82ff-f33f30e89247",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-26T10:52:17.6438194+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.