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": "71f37364-b22d-4983-9ac3-dba501908fef",
"jobs_id": "c01b2a97-4cac-43b3-970e-d8150b864c68",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b6283e07-9086-4e34-9265-1d194f972226",
"_parent_id": "2dfb13ec-9b72-41d7-a946-847b0ff36b17",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "61dae0d1-2d93-4ea3-9da2-2f5e5cbf9e42",
"project_reference_back_office": "sample string 5",
"project": {
"id": "dc116ce2-3e96-4778-954b-f5a8872a917e",
"_parent_id": "e4a205b1-324d-4d62-8437-b3985ab834c8",
"root_parent_id": "ebbca676-951b-4fe6-9d84-5a258f9fbb83",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d991ef26-1971-4914-8b27-eb12d8ebf3f4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "599aa577-a469-489c-a502-01de6f1a59a5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bbf85161-e93b-442f-8092-75193ef6bc3a",
"_parent_code": "sample string 6",
"sales_organization_id": "a69da5dd-3f70-4dfa-b8b5-97e00261c1ae",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3775efbb-9665-4376-a61b-52e351c015cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f61d9e28-0b76-41d7-8de4-a17c4ef787cc",
"db_currency_id": "9dd1b74c-6c78-4697-956a-a67945f7b10f",
"db_language_id": "1568ca83-7a89-4544-b9e0-fa7fc61b967e",
"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-09T07:27:43.6544593+00:00"
},
"modified_dateutc": "2026-07-09T07:27:43.6544593+00:00"
},
"equipment_model_id": "743e866d-2f82-4a9d-965e-08405654ea07",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "91c03cf1-e068-4b8d-852f-7e53cb205dc6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c53efce2-d345-4eee-8cf3-217ed4300d21",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2b1075db-c82f-4d27-ac7f-97330a7bc1bd",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b124cb95-6f5a-4510-a200-6603cec93847",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3775efbb-9665-4376-a61b-52e351c015cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f61d9e28-0b76-41d7-8de4-a17c4ef787cc",
"db_currency_id": "9dd1b74c-6c78-4697-956a-a67945f7b10f",
"db_language_id": "1568ca83-7a89-4544-b9e0-fa7fc61b967e",
"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-09T07:27:43.6544593+00:00"
},
"modified_dateutc": "2026-07-09T07:27:43.6544593+00:00"
},
"equipment_family_id": "30f3766f-e3cb-4842-befb-1afef8467d60",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "599aa577-a469-489c-a502-01de6f1a59a5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bbf85161-e93b-442f-8092-75193ef6bc3a",
"_parent_code": "sample string 6",
"sales_organization_id": "a69da5dd-3f70-4dfa-b8b5-97e00261c1ae",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3775efbb-9665-4376-a61b-52e351c015cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f61d9e28-0b76-41d7-8de4-a17c4ef787cc",
"db_currency_id": "9dd1b74c-6c78-4697-956a-a67945f7b10f",
"db_language_id": "1568ca83-7a89-4544-b9e0-fa7fc61b967e",
"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-09T07:27:43.6544593+00:00"
},
"modified_dateutc": "2026-07-09T07:27:43.6544593+00:00"
},
"date_in_production_since": "2026-07-09T07:27:43.6544593+00:00",
"date_out_of_production_since": "2026-07-09T07:27:43.6544593+00:00",
"date_end_support": "2026-07-09T07:27:43.6544593+00:00",
"sales_organization_id": "c76e73e9-5539-4048-ad3b-67dbe1b3f125",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3775efbb-9665-4376-a61b-52e351c015cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f61d9e28-0b76-41d7-8de4-a17c4ef787cc",
"db_currency_id": "9dd1b74c-6c78-4697-956a-a67945f7b10f",
"db_language_id": "1568ca83-7a89-4544-b9e0-fa7fc61b967e",
"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-09T07:27:43.6544593+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-09T07:27:43.6544593+00:00"
},
"project_status_id": "bcca3dca-6f6a-43ac-9eb1-542c794cd875",
"project_status_code": "sample string 10",
"project_status": {
"id": "90f543b2-e861-403d-be81-8c7a247ea829",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "808c5bcd-217f-4d76-a100-2ecc7e022e9c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3775efbb-9665-4376-a61b-52e351c015cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f61d9e28-0b76-41d7-8de4-a17c4ef787cc",
"db_currency_id": "9dd1b74c-6c78-4697-956a-a67945f7b10f",
"db_language_id": "1568ca83-7a89-4544-b9e0-fa7fc61b967e",
"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-09T07:27:43.6544593+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-09T07:27:43.6544593+00:00"
},
"company_id": "a0de599f-a784-432c-9f69-bfa2d0bfcc18",
"company_code": "sample string 12",
"db_address_id": "d9529c95-7d25-4a20-b3fc-c0ec65c04381",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "82ea10e1-72c0-4b9e-a579-0b0a0c858dbd",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cdbd2f64-d764-412e-8639-1243534149c0",
"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-09T07:27:43.6544593+00:00",
"date_create": "2026-07-09T07:27:43.6544593+00:00",
"date_update": "2026-07-09T07:27:43.6544593+00:00",
"updated_by_user_id": "ff1fd921-bc6f-4f64-a08c-bfac1d538837",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-09T07:27:43.6544593+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-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-09T07:27:43.6544593+00:00",
"date_last_job": "2026-07-09T07:27:43.6544593+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-09T07:27:43.6544593+00:00",
"modified_dateutc": "2026-07-09T07:27:43.6544593+00:00",
"is_mobile_installation": true
},
"job_type_id": "5a994bb8-f497-4d06-b754-1a097f78c0d1",
"job_type_code": "sample string 7",
"job_type": {
"id": "27b6875a-672d-47d5-b305-44994d1838c3",
"name": "sample string 2",
"sales_organization_id": "77d7a957-1842-4ab6-b1a2-da13cda36e2b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-09T07:27:43.6544593+00:00",
"code": "sample string 7"
},
"job_priority_id": "32bbfb08-aee5-46ac-8ae8-66c7b7cb0652",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "26204244-e946-4297-8900-20aa222cca8f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2ff1eedc-af0d-4948-930a-b6c34191daa6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3775efbb-9665-4376-a61b-52e351c015cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f61d9e28-0b76-41d7-8de4-a17c4ef787cc",
"db_currency_id": "9dd1b74c-6c78-4697-956a-a67945f7b10f",
"db_language_id": "1568ca83-7a89-4544-b9e0-fa7fc61b967e",
"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-09T07:27:43.6544593+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-09T07:27:43.6544593+00:00"
},
"job_status_id": "b6b3869b-c078-4170-9944-28dc10ae8eac",
"job_status_code": "sample string 11",
"db_address_id": "fe4adcf6-8ad9-4359-bf88-0ed250aaeec6",
"contact_id": "375efacd-0403-441e-8846-65dc9e85b3f9",
"requested_by_company_id": "48c437c7-8334-489c-8c91-d4f11c821f2b",
"requested_by_contact_id": "3fb45d70-4049-4d9e-952e-9cfb5d88eff6",
"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-09T07:27:43.6544593+00:00",
"due_date": "2026-07-09T07:27:43.6544593+00:00",
"date_create": "2026-07-09T07:27:43.6544593+00:00",
"date_update": "2026-07-09T07:27:43.6544593+00:00",
"date_closed": "2026-07-09T07:27:43.6544593+00:00",
"suggested_user_id": "7489cb38-6a7a-4404-b122-7a77baca2866",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "cdcff14e-4549-4695-9fbb-6476e9fa66f5",
"db_language_id": "441aee20-be18-43e2-8b8e-e6f18b8ab8b9",
"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-09T07:27:43.6544593+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d6cc2b94-26da-4202-b331-70fc60add02e",
"sales_organization": {
"id": "3775efbb-9665-4376-a61b-52e351c015cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f61d9e28-0b76-41d7-8de4-a17c4ef787cc",
"db_currency_id": "9dd1b74c-6c78-4697-956a-a67945f7b10f",
"db_language_id": "1568ca83-7a89-4544-b9e0-fa7fc61b967e",
"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-09T07:27:43.6544593+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "771b0bb0-f81e-48a4-9fae-fe91d7905a71",
"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": "76820a6b-8f98-4db0-bdc8-0dea619fe82f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-09T07:27:43.6544593+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4431151b-be50-4971-8ef4-fc8528a47075"
},
"suggested_date_start": "2026-07-09T07:27:43.6544593+00:00",
"skill_id": "097b28a5-951f-42b4-8507-cbc5aed112b7",
"skill_code": "sample string 32",
"skill": {
"id": "65922191-54a8-491a-a270-ac67619f048f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6b1cdcdb-fbbb-4953-8f57-fc2505728972",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3775efbb-9665-4376-a61b-52e351c015cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f61d9e28-0b76-41d7-8de4-a17c4ef787cc",
"db_currency_id": "9dd1b74c-6c78-4697-956a-a67945f7b10f",
"db_language_id": "1568ca83-7a89-4544-b9e0-fa7fc61b967e",
"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-09T07:27:43.6544593+00:00"
},
"modified_dateutc": "2026-07-09T07:27:43.6544593+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2455a1c3-0a13-4c6e-93e7-e90ef4bc621b",
"date_reported_by_company": "2026-07-09T07:27:43.6544593+00:00",
"id2": 36,
"company_id": "630bd059-516b-41d5-9a52-d38dee750341",
"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": "fcfc4241-4161-4f97-81d1-29af7061aa54",
"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-09T07:27:43.6544593+00:00"
},
"work_instruction_details_id": "24b28a47-4b7b-4199-a4ed-6f4c2a1ac271",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "185c7463-2e4f-48fb-8232-916ce7fb29ca",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "22dc7b8e-b5bb-47fd-89f2-68847ecc7a87",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-09T07:27:43.6544593+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": "218d0645-9bbf-4902-aeb6-f9432237c937",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-09T07:27:43.6544593+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.