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": "0e7bacfa-41cf-486c-9660-c192d1a50911",
"jobs_id": "d4958881-da33-4962-9249-854aaabc509f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "700652b0-a4da-4d76-9835-92fb86226d69",
"_parent_id": "9110b5bb-4e44-4b2e-a45e-c4e73d7c0b13",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b2f5ffa9-041d-4c20-8453-de4319091160",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6f1dcc5c-fc0d-4f29-ab4b-7647a99a5627",
"_parent_id": "9c0fd69c-0899-4ba5-ae81-567ad6df9d0e",
"root_parent_id": "90c7e4df-9d1f-46a7-bc01-4dfc16140907",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "412a60f8-95c9-46a2-9f54-ac1eb4619b20",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ecad962f-1aec-4bcb-9043-8d9fede3548b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dcfab489-e9dc-43f6-9b81-dd6f23bc6f72",
"_parent_code": "sample string 6",
"sales_organization_id": "738429d0-389d-4126-b7d4-46e34c4bf3d5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "25e4a613-8a38-4c15-b5b0-b3c643082080",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "884e039e-1078-4606-978b-8dc084e5b9a7",
"db_currency_id": "d6bc37dd-c2d2-4492-be9c-ef96ecb2d2ad",
"db_language_id": "0ec6c6b2-6cf5-4725-8088-52b6260d8917",
"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": "2025-09-18T15:51:06.8043114+00:00"
},
"modified_dateutc": "2025-09-18T15:51:06.8043114+00:00"
},
"equipment_model_id": "fc70d783-46e2-4ea8-90b6-9f656de0311b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f679a449-32eb-409c-9842-d3be50dd36d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d1dfcbc3-0438-4dee-983f-e294331b5750",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "56dc2d33-480f-4713-8cca-bc1fb02db010",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6ff6e2f3-ec3e-41b1-8b9f-795bfdb38437",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "25e4a613-8a38-4c15-b5b0-b3c643082080",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "884e039e-1078-4606-978b-8dc084e5b9a7",
"db_currency_id": "d6bc37dd-c2d2-4492-be9c-ef96ecb2d2ad",
"db_language_id": "0ec6c6b2-6cf5-4725-8088-52b6260d8917",
"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": "2025-09-18T15:51:06.8043114+00:00"
},
"modified_dateutc": "2025-09-18T15:51:06.8043114+00:00"
},
"equipment_family_id": "17b46b55-d078-4f97-bd11-0eecb4e779c2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ecad962f-1aec-4bcb-9043-8d9fede3548b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dcfab489-e9dc-43f6-9b81-dd6f23bc6f72",
"_parent_code": "sample string 6",
"sales_organization_id": "738429d0-389d-4126-b7d4-46e34c4bf3d5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "25e4a613-8a38-4c15-b5b0-b3c643082080",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "884e039e-1078-4606-978b-8dc084e5b9a7",
"db_currency_id": "d6bc37dd-c2d2-4492-be9c-ef96ecb2d2ad",
"db_language_id": "0ec6c6b2-6cf5-4725-8088-52b6260d8917",
"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": "2025-09-18T15:51:06.8043114+00:00"
},
"modified_dateutc": "2025-09-18T15:51:06.8043114+00:00"
},
"date_in_production_since": "2025-09-18T15:51:06.8043114+00:00",
"date_out_of_production_since": "2025-09-18T15:51:06.8043114+00:00",
"date_end_support": "2025-09-18T15:51:06.8043114+00:00",
"sales_organization_id": "b2198e3f-ea94-4ac8-9861-92ba840689f6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "25e4a613-8a38-4c15-b5b0-b3c643082080",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "884e039e-1078-4606-978b-8dc084e5b9a7",
"db_currency_id": "d6bc37dd-c2d2-4492-be9c-ef96ecb2d2ad",
"db_language_id": "0ec6c6b2-6cf5-4725-8088-52b6260d8917",
"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": "2025-09-18T15:51:06.8043114+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": "2025-09-18T15:51:06.8043114+00:00"
},
"project_status_id": "729113b9-bc82-4903-bda1-f25098b3d732",
"project_status_code": "sample string 10",
"project_status": {
"id": "b5bf65f8-64fd-4529-969a-8ea9d6f12103",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "957c0c3e-a243-4b94-8a91-41455c98c402",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "25e4a613-8a38-4c15-b5b0-b3c643082080",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "884e039e-1078-4606-978b-8dc084e5b9a7",
"db_currency_id": "d6bc37dd-c2d2-4492-be9c-ef96ecb2d2ad",
"db_language_id": "0ec6c6b2-6cf5-4725-8088-52b6260d8917",
"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": "2025-09-18T15:51:06.8043114+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-18T15:51:06.8043114+00:00"
},
"company_id": "c946f160-640b-4cc4-89d2-fffe525c5e95",
"company_code": "sample string 12",
"db_address_id": "424d3f3f-a29c-4df8-a84a-341617e25bfc",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "511cb05b-d034-4e85-a85f-dc18ab511ed5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9c7bc098-b982-4c07-b267-bd878fc6cabd",
"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": "2025-09-18T15:51:06.8043114+00:00",
"date_create": "2025-09-18T15:51:06.8043114+00:00",
"date_update": "2025-09-18T15:51:06.8043114+00:00",
"updated_by_user_id": "66a80674-c3a1-4eec-807f-2ecd8115c47c",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-09-18T15:51:06.8043114+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": "2025-09-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-09-18T15:51:06.8043114+00:00",
"date_last_job": "2025-09-18T15:51:06.8043114+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-09-18T15:51:06.8043114+00:00",
"modified_dateutc": "2025-09-18T15:51:06.8043114+00:00",
"is_mobile_installation": true
},
"job_type_id": "f78b59bb-a723-42ee-911c-287f0794e997",
"job_type_code": "sample string 7",
"job_type": {
"id": "a2431ab3-5cb0-4213-b725-afc3a3e827c9",
"name": "sample string 2",
"sales_organization_id": "9b96c527-0ade-44a5-8f66-51c4539dffcf",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-09-18T15:51:06.8043114+00:00",
"code": "sample string 7"
},
"job_priority_id": "61c21d72-fbff-42e5-bc63-d1762846a711",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "31cda546-52bf-40bb-b92c-464c5c829cf1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3fa3cb85-a582-4e0a-aba7-eaa46b2ff3e2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "25e4a613-8a38-4c15-b5b0-b3c643082080",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "884e039e-1078-4606-978b-8dc084e5b9a7",
"db_currency_id": "d6bc37dd-c2d2-4492-be9c-ef96ecb2d2ad",
"db_language_id": "0ec6c6b2-6cf5-4725-8088-52b6260d8917",
"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": "2025-09-18T15:51:06.8043114+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-18T15:51:06.8043114+00:00"
},
"job_status_id": "385b2c79-d863-45de-93ab-0785ba390a41",
"job_status_code": "sample string 11",
"db_address_id": "3707e991-5f74-4d93-95c3-5e34da63f453",
"contact_id": "959dbda0-3fe1-4a19-ad05-1aa990cf84f8",
"requested_by_company_id": "9d9fbe27-303d-4910-8570-919465f2be45",
"requested_by_contact_id": "67ffc7b5-c65e-4c42-b671-20be11b3bf34",
"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": "2025-09-18T15:51:06.8043114+00:00",
"due_date": "2025-09-18T15:51:06.8043114+00:00",
"date_create": "2025-09-18T15:51:06.8043114+00:00",
"date_update": "2025-09-18T15:51:06.8043114+00:00",
"date_closed": "2025-09-18T15:51:06.8043114+00:00",
"suggested_user_id": "d1853c62-4b79-4092-b8f5-e5bf33e81e1d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "bed74a3c-eb7c-4e75-bd58-2b2711277d67",
"db_language_id": "b413c288-4739-42f1-a51c-1cdac9aa38a1",
"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": "2025-09-18T15:51:06.8043114+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "72606ca1-26ad-450a-9d9e-69d7cbc886a4",
"sales_organization": {
"id": "25e4a613-8a38-4c15-b5b0-b3c643082080",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "884e039e-1078-4606-978b-8dc084e5b9a7",
"db_currency_id": "d6bc37dd-c2d2-4492-be9c-ef96ecb2d2ad",
"db_language_id": "0ec6c6b2-6cf5-4725-8088-52b6260d8917",
"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": "2025-09-18T15:51:06.8043114+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "57954d52-fa8b-46b3-a299-0598fa5f4837",
"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": "59d1b139-5de1-4add-a644-06f06be5abe7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-09-18T15:51:06.8043114+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "80fd062b-38ee-4e98-a11c-4f67324c2ad4"
},
"suggested_date_start": "2025-09-18T15:51:06.8043114+00:00",
"skill_id": "960f07c4-a317-449b-b3fe-888b5cc26b86",
"skill_code": "sample string 32",
"skill": {
"id": "45ccfc28-26e4-482b-bc65-102637bf3e4e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "55b40447-951a-410c-b243-c633c8b64f46",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "25e4a613-8a38-4c15-b5b0-b3c643082080",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "884e039e-1078-4606-978b-8dc084e5b9a7",
"db_currency_id": "d6bc37dd-c2d2-4492-be9c-ef96ecb2d2ad",
"db_language_id": "0ec6c6b2-6cf5-4725-8088-52b6260d8917",
"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": "2025-09-18T15:51:06.8043114+00:00"
},
"modified_dateutc": "2025-09-18T15:51:06.8043114+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "540dace0-8fb6-4588-8c40-9f715eea4a23",
"date_reported_by_company": "2025-09-18T15:51:06.8043114+00:00",
"id2": 36,
"company_id": "fa84a539-4b35-4f9f-bcc4-e3397b7cbbc7",
"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": "445ce408-682d-4fc2-8005-758f4fd2e63a",
"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": "2025-09-18T15:51:06.8043114+00:00"
},
"work_instruction_details_id": "c0201998-22d2-4e21-a102-3fa34ee3abf9",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4b332de3-31c2-4c5e-b459-0a1dd4503fd1",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "797a33b0-c8d5-4a49-8af2-6104388fdf3c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-09-18T15:51:06.8043114+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": "de7d0a33-2a9e-4c89-97da-7c2c437417d2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-09-18T15:51:06.8043114+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.