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": "5c8989bb-0213-43fc-8446-c1d8ca8c24fa",
"jobs_id": "e9cf2cca-e27e-4156-8d24-e9c26e4f009e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7de7a66d-240b-4ced-95ff-b1a59302a736",
"_parent_id": "855be4db-99db-4122-a321-a4b1dc5b3c94",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "295e258b-bf13-4b14-a320-51c861dd14af",
"project_reference_back_office": "sample string 5",
"project": {
"id": "fcc0e983-ac3c-4444-9b1c-9893db8bd419",
"_parent_id": "a73dcbc1-89f6-412e-aaac-679162b9ccc5",
"root_parent_id": "6ff2db9c-01dd-4fc4-883e-c225f852277e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f1df3b66-a687-4920-91a1-26c520a962d1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3819859e-e100-4630-87b9-987a32de0ba6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f250e6bb-de43-41fd-a034-945d05cbfac0",
"_parent_code": "sample string 6",
"sales_organization_id": "24d2fdbf-eccd-4386-9313-b97132ea3d5c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b01d3d3e-1958-4d4b-97ff-f70f32b06480",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bfe15900-a283-47d8-a798-b5849e6e3252",
"db_currency_id": "25983113-eb20-4d63-b38d-60aa12a91452",
"db_language_id": "327e073c-1373-4417-a8a6-cc240a2aead4",
"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-04-19T11:36:59.5632083+00:00"
},
"modified_dateutc": "2026-04-19T11:36:59.5788388+00:00"
},
"equipment_model_id": "c7099417-d563-4e73-9446-fb660ed82120",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8c56c4ec-3334-4933-be1f-8359e9f50323",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5e479488-59f8-4b18-8cd4-24f99046de06",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "95308113-88e1-4c46-ad6c-73245f4eba44",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f6e000e2-47bb-4888-8a5f-946fe6103494",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b01d3d3e-1958-4d4b-97ff-f70f32b06480",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bfe15900-a283-47d8-a798-b5849e6e3252",
"db_currency_id": "25983113-eb20-4d63-b38d-60aa12a91452",
"db_language_id": "327e073c-1373-4417-a8a6-cc240a2aead4",
"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-04-19T11:36:59.5632083+00:00"
},
"modified_dateutc": "2026-04-19T11:36:59.5788388+00:00"
},
"equipment_family_id": "9644a752-5ea7-4953-be65-c9e716fec147",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3819859e-e100-4630-87b9-987a32de0ba6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f250e6bb-de43-41fd-a034-945d05cbfac0",
"_parent_code": "sample string 6",
"sales_organization_id": "24d2fdbf-eccd-4386-9313-b97132ea3d5c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b01d3d3e-1958-4d4b-97ff-f70f32b06480",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bfe15900-a283-47d8-a798-b5849e6e3252",
"db_currency_id": "25983113-eb20-4d63-b38d-60aa12a91452",
"db_language_id": "327e073c-1373-4417-a8a6-cc240a2aead4",
"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-04-19T11:36:59.5632083+00:00"
},
"modified_dateutc": "2026-04-19T11:36:59.5788388+00:00"
},
"date_in_production_since": "2026-04-19T11:36:59.5788388+00:00",
"date_out_of_production_since": "2026-04-19T11:36:59.5788388+00:00",
"date_end_support": "2026-04-19T11:36:59.5788388+00:00",
"sales_organization_id": "fb4a308e-a604-4f2e-a0ca-a3b621419246",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b01d3d3e-1958-4d4b-97ff-f70f32b06480",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bfe15900-a283-47d8-a798-b5849e6e3252",
"db_currency_id": "25983113-eb20-4d63-b38d-60aa12a91452",
"db_language_id": "327e073c-1373-4417-a8a6-cc240a2aead4",
"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-04-19T11:36:59.5632083+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-04-19T11:36:59.5788388+00:00"
},
"project_status_id": "20d4ace2-6711-410b-a56b-ae0ef32dc716",
"project_status_code": "sample string 10",
"project_status": {
"id": "01cd4e36-a35c-492c-9ab7-3d394923a031",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "11cd2801-d77f-4a5f-8036-a5a60101bf3c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b01d3d3e-1958-4d4b-97ff-f70f32b06480",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bfe15900-a283-47d8-a798-b5849e6e3252",
"db_currency_id": "25983113-eb20-4d63-b38d-60aa12a91452",
"db_language_id": "327e073c-1373-4417-a8a6-cc240a2aead4",
"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-04-19T11:36:59.5632083+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-19T11:36:59.5788388+00:00"
},
"company_id": "5acd869b-d063-472b-ae2d-45adda42c147",
"company_code": "sample string 12",
"db_address_id": "3700a4b6-567a-4e22-8c5c-e16e8b41a78d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ec8633e8-0265-4dc0-a18b-9175a1c4c34d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "73168ca5-85f3-4612-a110-35ca4f732e0b",
"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-04-19T11:36:59.5788388+00:00",
"date_create": "2026-04-19T11:36:59.5788388+00:00",
"date_update": "2026-04-19T11:36:59.5788388+00:00",
"updated_by_user_id": "0687238e-1ed6-48c8-8d02-b86529d9bc54",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-19T11:36:59.5788388+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-04-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-19T11:36:59.5788388+00:00",
"date_last_job": "2026-04-19T11:36:59.5788388+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-19T11:36:59.5788388+00:00",
"modified_dateutc": "2026-04-19T11:36:59.5788388+00:00",
"is_mobile_installation": true
},
"job_type_id": "cd89f844-7696-4656-935a-2479b9a90a55",
"job_type_code": "sample string 7",
"job_type": {
"id": "62e11106-2b04-4fd3-8481-7c4d57d406de",
"name": "sample string 2",
"sales_organization_id": "84c63fe3-08c1-47c8-847b-4ebac48755de",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-19T11:36:59.5788388+00:00",
"code": "sample string 7"
},
"job_priority_id": "709fe956-b11e-4e18-92b1-0309a5110a1a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "24592cfb-6cb9-4bee-ba56-ed8198c0875d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1409d050-d957-4081-bc8d-fc2ea483f52a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b01d3d3e-1958-4d4b-97ff-f70f32b06480",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bfe15900-a283-47d8-a798-b5849e6e3252",
"db_currency_id": "25983113-eb20-4d63-b38d-60aa12a91452",
"db_language_id": "327e073c-1373-4417-a8a6-cc240a2aead4",
"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-04-19T11:36:59.5632083+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-19T11:36:59.5788388+00:00"
},
"job_status_id": "406bd947-4349-4940-bcb9-6e6cbb7e9696",
"job_status_code": "sample string 11",
"db_address_id": "0715f0d9-c18f-48d6-bbff-b9161c00a557",
"contact_id": "b7620a8e-061d-4f5e-a15e-108a384f59cc",
"requested_by_company_id": "ff3491e7-263b-43d4-802d-b5d115680483",
"requested_by_contact_id": "f9654267-3024-4bc7-8b03-a2c6e40fda90",
"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-04-19T11:36:59.5788388+00:00",
"due_date": "2026-04-19T11:36:59.5788388+00:00",
"date_create": "2026-04-19T11:36:59.5788388+00:00",
"date_update": "2026-04-19T11:36:59.5788388+00:00",
"date_closed": "2026-04-19T11:36:59.5788388+00:00",
"suggested_user_id": "bca4c491-fec1-4f1b-adfb-51a6bdc01430",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1435c30f-7669-4d9e-b1d9-856fe7092488",
"db_language_id": "fc1b97b2-a166-43fc-8c6d-fdaa343cd876",
"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-04-19T11:36:59.5788388+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3583534f-a655-4b56-8c9c-91400be65f92",
"sales_organization": {
"id": "b01d3d3e-1958-4d4b-97ff-f70f32b06480",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bfe15900-a283-47d8-a798-b5849e6e3252",
"db_currency_id": "25983113-eb20-4d63-b38d-60aa12a91452",
"db_language_id": "327e073c-1373-4417-a8a6-cc240a2aead4",
"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-04-19T11:36:59.5632083+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2f5d0a85-38f8-4211-b08a-d15a2df95e00",
"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": "a3bfab71-b3f3-4a81-95f0-eb5cb246fad3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-19T11:36:59.5788388+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "640d496a-07fa-4a78-ae96-e0b2c38018c5"
},
"suggested_date_start": "2026-04-19T11:36:59.5788388+00:00",
"skill_id": "81d41648-0137-47bd-bdd0-4545f111a8b9",
"skill_code": "sample string 32",
"skill": {
"id": "b6bf398d-3b2e-4c54-aac8-70a5c84a5ffe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e90fba0f-0550-4f9a-9eb9-f28254e629f2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b01d3d3e-1958-4d4b-97ff-f70f32b06480",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bfe15900-a283-47d8-a798-b5849e6e3252",
"db_currency_id": "25983113-eb20-4d63-b38d-60aa12a91452",
"db_language_id": "327e073c-1373-4417-a8a6-cc240a2aead4",
"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-04-19T11:36:59.5632083+00:00"
},
"modified_dateutc": "2026-04-19T11:36:59.5788388+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "48cf28c8-10ec-4419-9512-c4c75736e162",
"date_reported_by_company": "2026-04-19T11:36:59.5788388+00:00",
"id2": 36,
"company_id": "617744f7-37dc-4c67-badb-14eba891a3b2",
"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": "443d23b9-650e-42dd-9e3c-4cb83f5ac035",
"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-04-19T11:36:59.5788388+00:00"
},
"work_instruction_details_id": "f461fa19-24a1-47eb-9a83-40cdc200ddc4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f8425de0-da93-49ab-81a2-6fb838a77aa7",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "41f6784b-edd2-4d3c-9f14-1fb6f254dc3e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-19T11:36:59.5788388+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": "a034ed3f-6eaf-419e-bd98-e276d61abfc5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-19T11:36:59.5788388+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.