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": "ddc27bff-cb35-43d8-b99e-0cb963a7e848",
"jobs_id": "3313b4bf-277f-4e90-92c9-b892043ab423",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "004ce443-8d25-414d-8f19-88d86b4e178f",
"_parent_id": "3bb1b36a-58b8-422f-8fd1-17b8ad054a41",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "31893144-77d5-4e44-b34f-8c89697a68f3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8bd68ddf-2936-4985-98bb-c76b38fbad78",
"_parent_id": "f898f909-6189-42b0-8512-07e2e7617f93",
"root_parent_id": "7bb24824-a866-41ba-9a23-53dccd704ea5",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e8d7dccb-efac-4c97-aab9-6f6ebba0881e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1250ba70-37d8-4cec-9c19-c30ed51132b6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0b8aa0e6-57a3-4318-863a-7b63cfc00092",
"_parent_code": "sample string 6",
"sales_organization_id": "f166ee1c-1e8d-4f7e-ba7a-fe9d9b8be446",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d948c46f-14b4-43f2-99bd-a5853e5aa057",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f60096d-560b-45ac-a4b2-5b14ea761959",
"db_currency_id": "5226c859-10aa-47c1-a166-c5cbe719a77d",
"db_language_id": "0debc031-fc85-4fa9-81eb-3c9faacbdd0b",
"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-08T06:43:03.9084005+00:00"
},
"modified_dateutc": "2026-10-08T06:43:03.9436752+00:00"
},
"equipment_model_id": "b8cac80e-9862-464c-a7e8-00bb18c52b64",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4a3b3444-0322-45a2-ac3c-73b2f3482e5b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "797ab4c3-db90-429e-abf1-c115ba19fe45",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "75a8d4c6-8358-4ca7-9d12-6b8a82a50a4f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c733668e-c356-49dd-8bda-2e73c3588294",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d948c46f-14b4-43f2-99bd-a5853e5aa057",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f60096d-560b-45ac-a4b2-5b14ea761959",
"db_currency_id": "5226c859-10aa-47c1-a166-c5cbe719a77d",
"db_language_id": "0debc031-fc85-4fa9-81eb-3c9faacbdd0b",
"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-08T06:43:03.9084005+00:00"
},
"modified_dateutc": "2026-10-08T06:43:03.9865206+00:00"
},
"equipment_family_id": "520a32d4-1597-4db5-b3ef-0e1265e7d573",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1250ba70-37d8-4cec-9c19-c30ed51132b6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0b8aa0e6-57a3-4318-863a-7b63cfc00092",
"_parent_code": "sample string 6",
"sales_organization_id": "f166ee1c-1e8d-4f7e-ba7a-fe9d9b8be446",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d948c46f-14b4-43f2-99bd-a5853e5aa057",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f60096d-560b-45ac-a4b2-5b14ea761959",
"db_currency_id": "5226c859-10aa-47c1-a166-c5cbe719a77d",
"db_language_id": "0debc031-fc85-4fa9-81eb-3c9faacbdd0b",
"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-08T06:43:03.9084005+00:00"
},
"modified_dateutc": "2026-10-08T06:43:03.9436752+00:00"
},
"date_in_production_since": "2026-10-08T06:43:03.9865206+00:00",
"date_out_of_production_since": "2026-10-08T06:43:03.9865206+00:00",
"date_end_support": "2026-10-08T06:43:03.9865206+00:00",
"sales_organization_id": "909040bf-77a9-4e05-b932-768ec7a93737",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d948c46f-14b4-43f2-99bd-a5853e5aa057",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f60096d-560b-45ac-a4b2-5b14ea761959",
"db_currency_id": "5226c859-10aa-47c1-a166-c5cbe719a77d",
"db_language_id": "0debc031-fc85-4fa9-81eb-3c9faacbdd0b",
"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-08T06:43:03.9084005+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-08T06:43:04.0825405+00:00"
},
"project_status_id": "3cd919b5-ecda-4a9a-903c-ee7b7712f0ab",
"project_status_code": "sample string 10",
"project_status": {
"id": "b8dc01eb-c819-4a1c-850e-fd352ad12a66",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c2767650-39db-4548-9e75-9db987ba7a3a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d948c46f-14b4-43f2-99bd-a5853e5aa057",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f60096d-560b-45ac-a4b2-5b14ea761959",
"db_currency_id": "5226c859-10aa-47c1-a166-c5cbe719a77d",
"db_language_id": "0debc031-fc85-4fa9-81eb-3c9faacbdd0b",
"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-08T06:43:03.9084005+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-08T06:43:04.0825405+00:00"
},
"company_id": "feb023ee-4e07-4aec-9d5b-03c20adc716d",
"company_code": "sample string 12",
"db_address_id": "344141ef-c068-42d6-97f5-f77db1083b02",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "39d44087-3667-4aa1-a248-5802b72c70b0",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "78843e26-64ae-4874-90c7-6a5b4850b18e",
"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-08T06:43:04.0825405+00:00",
"date_create": "2026-10-08T06:43:04.0825405+00:00",
"date_update": "2026-10-08T06:43:04.0825405+00:00",
"updated_by_user_id": "1ebf884b-c4d8-4483-a362-c4af8d75e979",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-08T06:43:04.0825405+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-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-08T06:43:04.0825405+00:00",
"date_last_job": "2026-10-08T06:43:04.0825405+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-08T06:43:04.0825405+00:00",
"modified_dateutc": "2026-10-08T06:43:04.0825405+00:00",
"is_mobile_installation": true
},
"job_type_id": "225c2b45-df99-40ba-9137-3e206ea77a09",
"job_type_code": "sample string 7",
"job_type": {
"id": "81512b11-60e3-4191-8dfb-60a17a1c558c",
"name": "sample string 2",
"sales_organization_id": "08243570-34e5-4149-b542-6bf5364507c1",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-08T06:43:04.0825405+00:00",
"code": "sample string 7"
},
"job_priority_id": "0df42a4c-3638-4d49-9f47-b87018ba5e2b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "02c5a11e-73dd-4bb1-b658-1d4ce2d84948",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a315837b-8ffd-4662-9e8c-dcd7db814197",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d948c46f-14b4-43f2-99bd-a5853e5aa057",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f60096d-560b-45ac-a4b2-5b14ea761959",
"db_currency_id": "5226c859-10aa-47c1-a166-c5cbe719a77d",
"db_language_id": "0debc031-fc85-4fa9-81eb-3c9faacbdd0b",
"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-08T06:43:03.9084005+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-08T06:43:04.0825405+00:00"
},
"job_status_id": "b8e01e3f-6f6d-4d39-a92c-e049d6de99d9",
"job_status_code": "sample string 11",
"db_address_id": "d4ad2636-43ac-4c6d-be75-47ce9455e9db",
"contact_id": "2308b232-b603-46ca-bba5-1a0444a67eb2",
"requested_by_company_id": "f3f45c1d-ce76-4fac-9bae-952d15db2f31",
"requested_by_contact_id": "13f65303-85cc-41bc-ab75-bcc670c4fa7f",
"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-08T06:43:04.0959582+00:00",
"due_date": "2026-10-08T06:43:04.0959582+00:00",
"date_create": "2026-10-08T06:43:04.0959582+00:00",
"date_update": "2026-10-08T06:43:04.0959582+00:00",
"date_closed": "2026-10-08T06:43:04.0959582+00:00",
"suggested_user_id": "6c11529e-ff9f-4b65-952f-968619b173fb",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2151781c-9229-4278-8a5e-5c53be068038",
"db_language_id": "a6e4f294-a6a0-4332-9d50-a3ebb588a5f8",
"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-08T06:43:04.0959582+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6cfc6c40-f7d1-45f9-9dc3-65820a943029",
"sales_organization": {
"id": "d948c46f-14b4-43f2-99bd-a5853e5aa057",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f60096d-560b-45ac-a4b2-5b14ea761959",
"db_currency_id": "5226c859-10aa-47c1-a166-c5cbe719a77d",
"db_language_id": "0debc031-fc85-4fa9-81eb-3c9faacbdd0b",
"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-08T06:43:03.9084005+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ae1b1ab6-2259-421d-b9d6-1881820fda7d",
"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": "30f80490-c9e8-4aac-a2c0-627f4d7d44a8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-08T06:43:04.0959582+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "edc2215a-897c-4ccb-87ba-b3190eaa7f79"
},
"suggested_date_start": "2026-10-08T06:43:04.0959582+00:00",
"skill_id": "69b4be38-0733-49d4-a749-d5de1e621df4",
"skill_code": "sample string 32",
"skill": {
"id": "250e0de4-48e5-403e-b3c3-511da359d1ed",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0689a966-0b8b-4264-9eb7-a32f75839fcb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d948c46f-14b4-43f2-99bd-a5853e5aa057",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f60096d-560b-45ac-a4b2-5b14ea761959",
"db_currency_id": "5226c859-10aa-47c1-a166-c5cbe719a77d",
"db_language_id": "0debc031-fc85-4fa9-81eb-3c9faacbdd0b",
"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-08T06:43:03.9084005+00:00"
},
"modified_dateutc": "2026-10-08T06:43:04.0959582+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "db3776e3-c8aa-4733-a63a-1c0b16333c2d",
"date_reported_by_company": "2026-10-08T06:43:04.0959582+00:00",
"id2": 36,
"company_id": "54b28ebd-441d-499b-b465-ad4e15db5835",
"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": "d8b6ddad-0251-4e5f-9497-fc184f541275",
"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-08T06:43:04.1123236+00:00"
},
"work_instruction_details_id": "217fb26b-1df2-4535-ad98-ba1f411aecdf",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ce637ca5-7901-4402-af13-256275e0793d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2216db78-6cdf-480a-ad13-59d6a504efd0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-08T06:43:04.1123236+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": "718c1665-4e09-4476-8562-3f1c7479d0fd",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-08T06:43:04.1123236+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.