Creates a new job work instruction list.
Request Information
URI Parameters :
None.
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": "6d4a5e34-045e-44fa-89c0-04864134ca5c",
"jobs_id": "561cd74c-6328-4c56-a874-0fc84312df85",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3a376151-b9f0-48db-b1f3-02d28242b6ba",
"_parent_id": "8999fe7e-3b32-4972-b9b8-4e44521ec146",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d8d83b3f-ec4b-4006-96ba-317365b8de0f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "37535a91-2c7b-4e58-aae8-a62616332c08",
"_parent_id": "30e81d45-b909-4491-9122-21cc48470a06",
"root_parent_id": "374b2c77-6257-4f5e-aee5-9fc10dc889e8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f9a914b6-81ea-4b60-b4a7-2898bfad5775",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "79e0fb90-fe30-4428-ab27-ebcf562bd891",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4b7d72e7-16c6-43e0-ad3b-64d041aba029",
"_parent_code": "sample string 6",
"sales_organization_id": "1df1d6b9-4547-48df-b42e-5b375adecafd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "85b77806-0fe3-4b23-8e05-88790bd688ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c967f52c-5004-47f0-b789-56b38b6ce18e",
"db_currency_id": "bac55244-799d-4578-aad2-70de0e17b8d8",
"db_language_id": "4b11d259-5679-44fc-bbee-061bd926df1c",
"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-05-15T05:49:32.4663002+00:00"
},
"modified_dateutc": "2026-05-15T05:49:32.4663002+00:00"
},
"equipment_model_id": "481bb8ce-48dc-457e-b622-80fa711f1905",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8efaaa1e-112e-4be7-9a32-53139ce94974",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "59ef7be7-663b-4e4e-8a4a-be0ccdfe22e3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "142b752a-3336-4d3f-8286-f1de350435d9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7d74c037-47ba-4f7b-b253-a18a47811314",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "85b77806-0fe3-4b23-8e05-88790bd688ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c967f52c-5004-47f0-b789-56b38b6ce18e",
"db_currency_id": "bac55244-799d-4578-aad2-70de0e17b8d8",
"db_language_id": "4b11d259-5679-44fc-bbee-061bd926df1c",
"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-05-15T05:49:32.4663002+00:00"
},
"modified_dateutc": "2026-05-15T05:49:32.4663002+00:00"
},
"equipment_family_id": "bdb79b12-f13d-43ef-ac0f-4b3c036a272b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "79e0fb90-fe30-4428-ab27-ebcf562bd891",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4b7d72e7-16c6-43e0-ad3b-64d041aba029",
"_parent_code": "sample string 6",
"sales_organization_id": "1df1d6b9-4547-48df-b42e-5b375adecafd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "85b77806-0fe3-4b23-8e05-88790bd688ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c967f52c-5004-47f0-b789-56b38b6ce18e",
"db_currency_id": "bac55244-799d-4578-aad2-70de0e17b8d8",
"db_language_id": "4b11d259-5679-44fc-bbee-061bd926df1c",
"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-05-15T05:49:32.4663002+00:00"
},
"modified_dateutc": "2026-05-15T05:49:32.4663002+00:00"
},
"date_in_production_since": "2026-05-15T05:49:32.4663002+00:00",
"date_out_of_production_since": "2026-05-15T05:49:32.4663002+00:00",
"date_end_support": "2026-05-15T05:49:32.4663002+00:00",
"sales_organization_id": "ad4a3f28-64be-4652-811b-cf1e2d895935",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "85b77806-0fe3-4b23-8e05-88790bd688ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c967f52c-5004-47f0-b789-56b38b6ce18e",
"db_currency_id": "bac55244-799d-4578-aad2-70de0e17b8d8",
"db_language_id": "4b11d259-5679-44fc-bbee-061bd926df1c",
"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-05-15T05:49:32.4663002+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-05-15T05:49:32.4663002+00:00"
},
"project_status_id": "ae32a55d-eab6-4b56-bc63-420b2e451b4f",
"project_status_code": "sample string 10",
"project_status": {
"id": "62fc8574-dd68-4881-96e1-66b6586fd867",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d8f0bf8a-1389-419a-9138-401b0d0c5c25",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "85b77806-0fe3-4b23-8e05-88790bd688ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c967f52c-5004-47f0-b789-56b38b6ce18e",
"db_currency_id": "bac55244-799d-4578-aad2-70de0e17b8d8",
"db_language_id": "4b11d259-5679-44fc-bbee-061bd926df1c",
"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-05-15T05:49:32.4663002+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-15T05:49:32.4663002+00:00"
},
"company_id": "f1c56464-3dec-44f7-adc9-29245f3853f2",
"company_code": "sample string 12",
"db_address_id": "eaa9c50c-bb84-4c3e-96bb-434440fda4b3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5f43acb8-a1fa-4fc1-b4c7-45984fe3c9b7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8531535a-b91f-4f9d-9646-7e5139f87d72",
"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-05-15T05:49:32.4663002+00:00",
"date_create": "2026-05-15T05:49:32.4663002+00:00",
"date_update": "2026-05-15T05:49:32.4663002+00:00",
"updated_by_user_id": "1565cee2-c106-48a4-a678-b162cfe21b7c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-15T05:49:32.4663002+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-05-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-15T05:49:32.4663002+00:00",
"date_last_job": "2026-05-15T05:49:32.4663002+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-15T05:49:32.4663002+00:00",
"modified_dateutc": "2026-05-15T05:49:32.4663002+00:00",
"is_mobile_installation": true
},
"job_type_id": "4c25f3cc-5a85-4d0f-8d3b-013c4a0dd975",
"job_type_code": "sample string 7",
"job_type": {
"id": "ea7ec727-0a14-46db-b8d9-1f879048d129",
"name": "sample string 2",
"sales_organization_id": "6a328498-11e8-4d15-83e2-cdc028eb0c59",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-15T05:49:32.4663002+00:00",
"code": "sample string 7"
},
"job_priority_id": "522ab801-42eb-4003-8b97-1d3eafb5e4f6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "59766c2d-6cae-4be6-99fa-345399d800fe",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f1d5b9f7-4100-410f-a030-58d1bf812741",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "85b77806-0fe3-4b23-8e05-88790bd688ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c967f52c-5004-47f0-b789-56b38b6ce18e",
"db_currency_id": "bac55244-799d-4578-aad2-70de0e17b8d8",
"db_language_id": "4b11d259-5679-44fc-bbee-061bd926df1c",
"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-05-15T05:49:32.4663002+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-15T05:49:32.4663002+00:00"
},
"job_status_id": "03e91bb8-6192-4e8a-8469-5b85137c2079",
"job_status_code": "sample string 11",
"db_address_id": "3182e91e-5ae0-47d4-b023-ed23cea9de10",
"contact_id": "1376a279-036c-47c9-9999-a4dce4f4a621",
"requested_by_company_id": "0fe75748-707f-471e-8752-71567774a972",
"requested_by_contact_id": "37ec8bfd-7407-4200-a8a8-6c59464c5322",
"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-05-15T05:49:32.4663002+00:00",
"due_date": "2026-05-15T05:49:32.4663002+00:00",
"date_create": "2026-05-15T05:49:32.4663002+00:00",
"date_update": "2026-05-15T05:49:32.4663002+00:00",
"date_closed": "2026-05-15T05:49:32.4663002+00:00",
"suggested_user_id": "91e6e2e8-7d3c-4c36-9279-bbfe72463f3d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "41bb18eb-0e01-4f72-9428-9c5b6404aad6",
"db_language_id": "2a918e1f-9ed4-4158-aa45-07ecf16a7559",
"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-05-15T05:49:32.4663002+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f0d351a5-7e2b-44f8-bbb8-02358df8274f",
"sales_organization": {
"id": "85b77806-0fe3-4b23-8e05-88790bd688ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c967f52c-5004-47f0-b789-56b38b6ce18e",
"db_currency_id": "bac55244-799d-4578-aad2-70de0e17b8d8",
"db_language_id": "4b11d259-5679-44fc-bbee-061bd926df1c",
"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-05-15T05:49:32.4663002+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3980cec0-d0dc-4ad3-a882-88a1b7c0c9b6",
"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": "4b6023f0-5536-4b2f-9ccc-089760f1919a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-15T05:49:32.4663002+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e96fce78-c7be-45ff-912f-89e9987d05a0"
},
"suggested_date_start": "2026-05-15T05:49:32.4663002+00:00",
"skill_id": "6a428543-dd4d-4c5d-929c-e5750303bc13",
"skill_code": "sample string 32",
"skill": {
"id": "ce52a6b7-802b-4dcb-8c01-5d579246c164",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9d5b7116-1b7f-436b-8f73-0c264a8a0700",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "85b77806-0fe3-4b23-8e05-88790bd688ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c967f52c-5004-47f0-b789-56b38b6ce18e",
"db_currency_id": "bac55244-799d-4578-aad2-70de0e17b8d8",
"db_language_id": "4b11d259-5679-44fc-bbee-061bd926df1c",
"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-05-15T05:49:32.4663002+00:00"
},
"modified_dateutc": "2026-05-15T05:49:32.4663002+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f6fe50f2-3fa3-4d6c-a4bc-e9a288ee641e",
"date_reported_by_company": "2026-05-15T05:49:32.4663002+00:00",
"id2": 36,
"company_id": "837349cd-e14f-41c4-a365-09ae74dc6e7e",
"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": "1fc72f13-8569-4fbb-9683-abd3330d67ce",
"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-05-15T05:49:32.4663002+00:00"
},
"work_instruction_details_id": "31ee23e8-cec6-40b7-8bff-6d3ea070c7eb",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "99c9e65d-f535-4f5e-a613-a189375c434e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f6e18be9-0a05-4b7c-8363-ba672079ee02",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-15T05:49:32.4663002+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": "b75e1646-c567-41a1-9eef-7f0f937e19b7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-15T05:49:32.4663002+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.