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": "7b53d4b0-5b0b-4035-9e04-5edc91a20a20",
"jobs_id": "6ce7fa7c-0783-4bd0-b935-7988f904e393",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "08a3c983-3ba3-47b7-9388-d7eb4e5ba909",
"_parent_id": "75cf7c04-82e2-4698-822f-6c07afccfde1",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d52413d3-ccce-4bff-bf77-0b6c57ee696e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2ef5093f-9c06-47ee-93f8-5e285cbe3921",
"_parent_id": "c17efa1a-a3eb-454b-b476-440648b11f68",
"root_parent_id": "c587069d-83e7-4dd8-918f-63d498cff822",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "64a22d52-6621-4368-a433-3ba6e69133df",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6e1646c6-466e-491d-bd8e-96cd24e745f4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5db62c20-00e7-4127-85b7-bce20119b311",
"_parent_code": "sample string 6",
"sales_organization_id": "45ad10b6-016b-440b-9902-46df8cdf184f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f723db35-9efb-400f-904e-0d69bb4c2ee9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "875f2679-42f7-4273-b57f-487092cbc5b8",
"db_currency_id": "8f1a3a49-ad7a-441f-ac4b-ef0802b505ef",
"db_language_id": "47696bc5-8849-47e2-9d1a-fbbfd682f6e6",
"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-01T15:29:27.7039429+00:00"
},
"modified_dateutc": "2026-02-01T15:29:27.7039429+00:00"
},
"equipment_model_id": "2ef1b486-7709-492b-b1cc-76de2459e60f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2a917c4d-bfda-465f-8c88-6c3cf1c1184c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a9311c17-218d-4f40-bba6-57d30b44d290",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "12eff7d5-6cfc-4ebe-ba81-2edf63d55991",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c386ea2a-b3d4-417d-a4af-1fe375dd5e5a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f723db35-9efb-400f-904e-0d69bb4c2ee9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "875f2679-42f7-4273-b57f-487092cbc5b8",
"db_currency_id": "8f1a3a49-ad7a-441f-ac4b-ef0802b505ef",
"db_language_id": "47696bc5-8849-47e2-9d1a-fbbfd682f6e6",
"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-01T15:29:27.7039429+00:00"
},
"modified_dateutc": "2026-02-01T15:29:27.7039429+00:00"
},
"equipment_family_id": "b55c27c7-c2d3-4d80-a8d0-526dab41e60c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6e1646c6-466e-491d-bd8e-96cd24e745f4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5db62c20-00e7-4127-85b7-bce20119b311",
"_parent_code": "sample string 6",
"sales_organization_id": "45ad10b6-016b-440b-9902-46df8cdf184f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f723db35-9efb-400f-904e-0d69bb4c2ee9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "875f2679-42f7-4273-b57f-487092cbc5b8",
"db_currency_id": "8f1a3a49-ad7a-441f-ac4b-ef0802b505ef",
"db_language_id": "47696bc5-8849-47e2-9d1a-fbbfd682f6e6",
"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-01T15:29:27.7039429+00:00"
},
"modified_dateutc": "2026-02-01T15:29:27.7039429+00:00"
},
"date_in_production_since": "2026-02-01T15:29:27.7039429+00:00",
"date_out_of_production_since": "2026-02-01T15:29:27.7039429+00:00",
"date_end_support": "2026-02-01T15:29:27.7039429+00:00",
"sales_organization_id": "9f886ce0-ce27-49ba-bc70-04d6da4443c1",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f723db35-9efb-400f-904e-0d69bb4c2ee9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "875f2679-42f7-4273-b57f-487092cbc5b8",
"db_currency_id": "8f1a3a49-ad7a-441f-ac4b-ef0802b505ef",
"db_language_id": "47696bc5-8849-47e2-9d1a-fbbfd682f6e6",
"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-01T15:29:27.7039429+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-01T15:29:27.7039429+00:00"
},
"project_status_id": "3c73d786-8206-4c4c-8cb1-78d918722be8",
"project_status_code": "sample string 10",
"project_status": {
"id": "914a9b22-213b-453c-999d-9a3900165bf7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f59c0527-f67e-4eec-86e0-939f139e58c3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f723db35-9efb-400f-904e-0d69bb4c2ee9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "875f2679-42f7-4273-b57f-487092cbc5b8",
"db_currency_id": "8f1a3a49-ad7a-441f-ac4b-ef0802b505ef",
"db_language_id": "47696bc5-8849-47e2-9d1a-fbbfd682f6e6",
"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-01T15:29:27.7039429+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-01T15:29:27.7039429+00:00"
},
"company_id": "2a9ba250-2e29-40b1-8579-08bbbffb0c1e",
"company_code": "sample string 12",
"db_address_id": "25aa5fd1-7d74-40d3-93a8-9c90046a2b13",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "95e10801-2fbb-4c27-bf6f-7fd12e2e172a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e235c46d-ec51-4830-b6fa-6ba285e00868",
"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-01T15:29:27.7039429+00:00",
"date_create": "2026-02-01T15:29:27.7039429+00:00",
"date_update": "2026-02-01T15:29:27.7039429+00:00",
"updated_by_user_id": "46a09f70-21f6-4890-b418-81de3685f6fd",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-01T15:29:27.7039429+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-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-01T15:29:27.7039429+00:00",
"date_last_job": "2026-02-01T15:29:27.7039429+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-01T15:29:27.7039429+00:00",
"modified_dateutc": "2026-02-01T15:29:27.7039429+00:00",
"is_mobile_installation": true
},
"job_type_id": "079780cd-7722-45b4-aeff-46ac4b6b9b16",
"job_type_code": "sample string 7",
"job_type": {
"id": "ce933599-e337-40c4-ac7a-76d56d431bf9",
"name": "sample string 2",
"sales_organization_id": "53acc1f6-a405-41c3-acda-f5eb02912547",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-01T15:29:27.7039429+00:00",
"code": "sample string 7"
},
"job_priority_id": "fae2331b-39e2-4642-ae26-e421f751bf34",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d45cd8e9-9f3d-42b8-a190-225ed3375596",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "44bbcb60-3ffd-4298-a48b-f2b9d69e1a2c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f723db35-9efb-400f-904e-0d69bb4c2ee9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "875f2679-42f7-4273-b57f-487092cbc5b8",
"db_currency_id": "8f1a3a49-ad7a-441f-ac4b-ef0802b505ef",
"db_language_id": "47696bc5-8849-47e2-9d1a-fbbfd682f6e6",
"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-01T15:29:27.7039429+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-01T15:29:27.7039429+00:00"
},
"job_status_id": "76080083-4385-410e-a81b-053b56e1b7ac",
"job_status_code": "sample string 11",
"db_address_id": "4bb381f7-48e7-4c07-b243-a674a479fba5",
"contact_id": "ee5e3c4a-98cc-489e-afeb-1e54deb81bdd",
"requested_by_company_id": "a5add08a-9945-4d55-8aa7-bfd09ce76e0f",
"requested_by_contact_id": "2aeb8bae-7136-4026-990b-a76317836e2b",
"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-01T15:29:27.7039429+00:00",
"due_date": "2026-02-01T15:29:27.7039429+00:00",
"date_create": "2026-02-01T15:29:27.7039429+00:00",
"date_update": "2026-02-01T15:29:27.7039429+00:00",
"date_closed": "2026-02-01T15:29:27.7039429+00:00",
"suggested_user_id": "4ed4ab48-1192-4eb0-b327-d8b232403d70",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "373ba0e6-9fb6-43e6-9337-2020ca64dcf4",
"db_language_id": "33ba5377-3711-47b3-88aa-ab6dccfe135f",
"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-01T15:29:27.7039429+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "00ae08cb-14cd-45bf-84a8-ed0b7e8e9982",
"sales_organization": {
"id": "f723db35-9efb-400f-904e-0d69bb4c2ee9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "875f2679-42f7-4273-b57f-487092cbc5b8",
"db_currency_id": "8f1a3a49-ad7a-441f-ac4b-ef0802b505ef",
"db_language_id": "47696bc5-8849-47e2-9d1a-fbbfd682f6e6",
"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-01T15:29:27.7039429+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f2cc1089-3b5f-4e8e-a4be-ca55aa0ba76c",
"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": "ca85367f-4dc7-4384-a1e8-74a4f7476a92",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-01T15:29:27.7039429+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "bfdeb269-6cc1-4cf3-b006-308e7e90ef79"
},
"suggested_date_start": "2026-02-01T15:29:27.7039429+00:00",
"skill_id": "56edd2b5-64b0-4035-b908-65eabe194906",
"skill_code": "sample string 32",
"skill": {
"id": "7f7de3d4-7cd3-4f9e-af69-1dd5164bdb2d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e3befbe3-deb9-4324-93eb-d6796df446db",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f723db35-9efb-400f-904e-0d69bb4c2ee9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "875f2679-42f7-4273-b57f-487092cbc5b8",
"db_currency_id": "8f1a3a49-ad7a-441f-ac4b-ef0802b505ef",
"db_language_id": "47696bc5-8849-47e2-9d1a-fbbfd682f6e6",
"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-01T15:29:27.7039429+00:00"
},
"modified_dateutc": "2026-02-01T15:29:27.7039429+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ea74c536-27a9-49b0-b968-8277ebedd80d",
"date_reported_by_company": "2026-02-01T15:29:27.7039429+00:00",
"id2": 36,
"company_id": "3ec137a8-3492-40f3-873f-526944123c5a",
"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": "34cdf3de-d437-4285-a809-a934cfc82aeb",
"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-01T15:29:27.7039429+00:00"
},
"work_instruction_details_id": "b39dbc6f-db64-4668-84f4-bef0677c9cb4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "decf31ab-d32d-4f67-8d8d-7c9f556d04af",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "78e58cba-b415-4bdf-8759-e5535c547cdc",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-01T15:29:27.7039429+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": "75eb3b94-c438-42bd-8d11-b3723e3a4e88",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-01T15:29:27.7039429+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.