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": "c6a60f78-bf1c-4b1d-9716-d42ce779c16c",
"jobs_id": "775105fe-3f6f-46a4-a380-79050d061e63",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a76f1861-8153-49c0-9537-40d83a5f3443",
"_parent_id": "1f06d6f6-0537-4410-895c-ffb61f4b2c14",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "57460de8-3ad2-4c51-ac9c-2b62236e6511",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ff5f6ea9-aef9-42bf-a21a-983bb2b75de9",
"_parent_id": "3f218d7e-6d55-440a-ad31-3c5229a1b8d8",
"root_parent_id": "927cf84b-474d-49c0-967e-d5b0bd68be13",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "70c2f7c1-1391-4f37-8240-aa3db789158a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "560bdf09-4cf8-421b-b7d4-a527dd58bb3c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bbb15e49-4cfd-494c-83e8-0e900dc442e1",
"_parent_code": "sample string 6",
"sales_organization_id": "5b544759-bb12-422f-9328-add381cce291",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fa7e4426-cce8-4918-b15c-9dda43a10f16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "26cfef77-a6cd-48e7-bf0e-adce6b68cd1b",
"db_currency_id": "b0d11602-bebe-4c5b-b3c6-f15af4f4ffc1",
"db_language_id": "2d7b8e6d-e0b7-49f9-a1cf-b6a6edae2e09",
"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-02-26T12:10:58.4217603+00:00"
},
"modified_dateutc": "2026-02-26T12:10:58.4217603+00:00"
},
"equipment_model_id": "09b93e28-5942-4508-9894-cb5a8f4feb10",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "90fc5dd8-b964-461b-bd2a-38e5490140c3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e421be7a-5fb5-480a-924c-899a1306d3e0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "138671d1-e253-4593-874e-9f201f6b6bf2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "22313ac0-4a1d-4f37-9cfe-659cbb4061c2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fa7e4426-cce8-4918-b15c-9dda43a10f16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "26cfef77-a6cd-48e7-bf0e-adce6b68cd1b",
"db_currency_id": "b0d11602-bebe-4c5b-b3c6-f15af4f4ffc1",
"db_language_id": "2d7b8e6d-e0b7-49f9-a1cf-b6a6edae2e09",
"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-02-26T12:10:58.4217603+00:00"
},
"modified_dateutc": "2026-02-26T12:10:58.4217603+00:00"
},
"equipment_family_id": "594fab41-518b-43e5-a684-5e24030f4f82",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "560bdf09-4cf8-421b-b7d4-a527dd58bb3c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bbb15e49-4cfd-494c-83e8-0e900dc442e1",
"_parent_code": "sample string 6",
"sales_organization_id": "5b544759-bb12-422f-9328-add381cce291",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fa7e4426-cce8-4918-b15c-9dda43a10f16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "26cfef77-a6cd-48e7-bf0e-adce6b68cd1b",
"db_currency_id": "b0d11602-bebe-4c5b-b3c6-f15af4f4ffc1",
"db_language_id": "2d7b8e6d-e0b7-49f9-a1cf-b6a6edae2e09",
"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-02-26T12:10:58.4217603+00:00"
},
"modified_dateutc": "2026-02-26T12:10:58.4217603+00:00"
},
"date_in_production_since": "2026-02-26T12:10:58.4217603+00:00",
"date_out_of_production_since": "2026-02-26T12:10:58.4217603+00:00",
"date_end_support": "2026-02-26T12:10:58.4217603+00:00",
"sales_organization_id": "e54148e6-8515-4c9b-87db-3d973c6c0637",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fa7e4426-cce8-4918-b15c-9dda43a10f16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "26cfef77-a6cd-48e7-bf0e-adce6b68cd1b",
"db_currency_id": "b0d11602-bebe-4c5b-b3c6-f15af4f4ffc1",
"db_language_id": "2d7b8e6d-e0b7-49f9-a1cf-b6a6edae2e09",
"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-02-26T12:10:58.4217603+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-02-26T12:10:58.4217603+00:00"
},
"project_status_id": "8de71ede-57a4-42f2-94ee-a48ffb28143d",
"project_status_code": "sample string 10",
"project_status": {
"id": "1272eae3-3665-439d-bcfb-91fdc79b1d74",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "79e00aaa-0e9d-49e0-aaa5-67ecfb128786",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fa7e4426-cce8-4918-b15c-9dda43a10f16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "26cfef77-a6cd-48e7-bf0e-adce6b68cd1b",
"db_currency_id": "b0d11602-bebe-4c5b-b3c6-f15af4f4ffc1",
"db_language_id": "2d7b8e6d-e0b7-49f9-a1cf-b6a6edae2e09",
"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-02-26T12:10:58.4217603+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-26T12:10:58.437377+00:00"
},
"company_id": "86494cf6-93c9-4c8d-968b-255eb14288dc",
"company_code": "sample string 12",
"db_address_id": "8d20fb40-80bc-43ee-8aee-95e0c2fa0656",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "09138b44-6501-4517-a24d-706df46c84dc",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3c0a8394-89c2-40cd-9ad8-bc298904f044",
"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-02-26T12:10:58.437377+00:00",
"date_create": "2026-02-26T12:10:58.437377+00:00",
"date_update": "2026-02-26T12:10:58.437377+00:00",
"updated_by_user_id": "f7962507-edaf-4925-a7d1-b0bbf86a1617",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-26T12:10:58.437377+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-02-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-26T12:10:58.437377+00:00",
"date_last_job": "2026-02-26T12:10:58.437377+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-26T12:10:58.437377+00:00",
"modified_dateutc": "2026-02-26T12:10:58.437377+00:00",
"is_mobile_installation": true
},
"job_type_id": "4c891ed0-3614-4065-b2d9-33e68957e6da",
"job_type_code": "sample string 7",
"job_type": {
"id": "270d53e3-9cf9-4cfa-a6da-adfee36df664",
"name": "sample string 2",
"sales_organization_id": "9216d33b-f770-42c5-992e-a12e62deeda6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-26T12:10:58.437377+00:00",
"code": "sample string 7"
},
"job_priority_id": "cfd6bcc7-082a-479f-bb3a-b237fec23c2b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0c52871f-c736-4267-9158-1c863addc203",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "60f506e3-b897-4abd-80b1-7f4e697690c8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fa7e4426-cce8-4918-b15c-9dda43a10f16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "26cfef77-a6cd-48e7-bf0e-adce6b68cd1b",
"db_currency_id": "b0d11602-bebe-4c5b-b3c6-f15af4f4ffc1",
"db_language_id": "2d7b8e6d-e0b7-49f9-a1cf-b6a6edae2e09",
"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-02-26T12:10:58.4217603+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-26T12:10:58.437377+00:00"
},
"job_status_id": "b1f86ec1-b1ed-4615-bb0b-286aeaa60922",
"job_status_code": "sample string 11",
"db_address_id": "dca85f84-4a45-466d-af26-c6ba3c027e5b",
"contact_id": "7d023187-6ee7-4245-b99b-97f1ddf7b5ff",
"requested_by_company_id": "58a14787-64ff-45be-b23e-04b2a212f102",
"requested_by_contact_id": "53b88941-896f-4a79-8a1b-601131d34960",
"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-02-26T12:10:58.437377+00:00",
"due_date": "2026-02-26T12:10:58.437377+00:00",
"date_create": "2026-02-26T12:10:58.437377+00:00",
"date_update": "2026-02-26T12:10:58.437377+00:00",
"date_closed": "2026-02-26T12:10:58.437377+00:00",
"suggested_user_id": "1da617a8-579c-41a8-b8b6-852423fc8734",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8c18429b-8804-4356-96d5-613874d286d4",
"db_language_id": "6fa67e25-7e6f-496a-97df-6fc37c2d049c",
"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-02-26T12:10:58.437377+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "26108f74-36b6-4b1d-8998-68ed14b8ca8e",
"sales_organization": {
"id": "fa7e4426-cce8-4918-b15c-9dda43a10f16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "26cfef77-a6cd-48e7-bf0e-adce6b68cd1b",
"db_currency_id": "b0d11602-bebe-4c5b-b3c6-f15af4f4ffc1",
"db_language_id": "2d7b8e6d-e0b7-49f9-a1cf-b6a6edae2e09",
"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-02-26T12:10:58.4217603+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5af1c972-e4dc-4d67-946b-577fdd87ee75",
"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": "e420db7b-5343-480f-ab76-a27df81dfc8e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-26T12:10:58.437377+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "33a0c579-92e3-44e2-a473-e04d482a0fd0"
},
"suggested_date_start": "2026-02-26T12:10:58.437377+00:00",
"skill_id": "383298f0-308d-4c33-8f40-a5f8035e586c",
"skill_code": "sample string 32",
"skill": {
"id": "599eac24-a6ab-4cb1-a1c9-978c3b59d987",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8de374b1-8a51-46b3-a23c-c9e824374e30",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fa7e4426-cce8-4918-b15c-9dda43a10f16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "26cfef77-a6cd-48e7-bf0e-adce6b68cd1b",
"db_currency_id": "b0d11602-bebe-4c5b-b3c6-f15af4f4ffc1",
"db_language_id": "2d7b8e6d-e0b7-49f9-a1cf-b6a6edae2e09",
"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-02-26T12:10:58.4217603+00:00"
},
"modified_dateutc": "2026-02-26T12:10:58.437377+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "af27880e-0810-4df0-a64e-fb2e5d2fb2ed",
"date_reported_by_company": "2026-02-26T12:10:58.437377+00:00",
"id2": 36,
"company_id": "9d99e2bc-90a7-4816-adb4-4878e6f67833",
"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": "4b413e42-a583-48d6-a067-7f24beabaf03",
"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-02-26T12:10:58.437377+00:00"
},
"work_instruction_details_id": "50e94d45-a300-4d7d-a649-59cc058b8830",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "878d231e-2739-4539-b9eb-bfb87d72bf55",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9af78d12-aba0-430d-92e5-32008fd815ef",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-26T12:10:58.437377+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": "90edc097-434c-4511-84e3-2ba8c5c5dbda",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-26T12:10:58.437377+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.