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": "8fd5fd63-58a9-49bb-b3cd-2444a8eed4d9",
"jobs_id": "61e9a3b4-8ab0-4eea-b6b5-827a07c8997e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "bd564a6d-54df-42e5-9fd8-fa106dad2185",
"_parent_id": "6c8a5fcb-d8e9-4440-b82d-3a53d6563d9a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ea3cb971-fbbf-42b5-a387-e71983ec3627",
"project_reference_back_office": "sample string 5",
"project": {
"id": "16e4c1ca-cb69-4b82-94fe-70ea611b05a9",
"_parent_id": "41f7c51e-76f9-4b12-9cb8-aa873e497fca",
"root_parent_id": "847a657e-7146-4a7b-8c34-ff3bf4267b5d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0afb0faf-90c4-41c1-9bbe-df3b4baea609",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "faa276dd-2567-45fc-aa90-14fbdca7db69",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "64d9f32e-2f0c-4899-b9a3-6aab55848a97",
"_parent_code": "sample string 6",
"sales_organization_id": "e9834d9b-7257-4054-adb7-84c9d5f82a41",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "82196114-b500-4adb-bb71-59e691a6e146",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3fe9be05-033d-4def-ae5f-0e6989b9cbff",
"db_currency_id": "ecca019c-5b7c-4310-b89c-53560fab7cc4",
"db_language_id": "68554da0-4122-4685-9ae4-450aca2b5d28",
"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-08T01:54:13.8874007+00:00"
},
"modified_dateutc": "2026-10-08T01:54:13.8874007+00:00"
},
"equipment_model_id": "83fb992f-8f27-4f6c-8f31-e0257783d491",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ccd55c55-4c0a-4359-959c-26a7523d36e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b6bfee16-1036-4db2-bcab-f01a3d805b68",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3fd8ef09-6834-4f47-9bb8-4d691fdc372a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e78c2828-2302-4486-a51c-9a5436876a96",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "82196114-b500-4adb-bb71-59e691a6e146",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3fe9be05-033d-4def-ae5f-0e6989b9cbff",
"db_currency_id": "ecca019c-5b7c-4310-b89c-53560fab7cc4",
"db_language_id": "68554da0-4122-4685-9ae4-450aca2b5d28",
"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-08T01:54:13.8874007+00:00"
},
"modified_dateutc": "2026-10-08T01:54:13.8874007+00:00"
},
"equipment_family_id": "23af9ced-1935-4257-b35c-0999a30038bc",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "faa276dd-2567-45fc-aa90-14fbdca7db69",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "64d9f32e-2f0c-4899-b9a3-6aab55848a97",
"_parent_code": "sample string 6",
"sales_organization_id": "e9834d9b-7257-4054-adb7-84c9d5f82a41",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "82196114-b500-4adb-bb71-59e691a6e146",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3fe9be05-033d-4def-ae5f-0e6989b9cbff",
"db_currency_id": "ecca019c-5b7c-4310-b89c-53560fab7cc4",
"db_language_id": "68554da0-4122-4685-9ae4-450aca2b5d28",
"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-08T01:54:13.8874007+00:00"
},
"modified_dateutc": "2026-10-08T01:54:13.8874007+00:00"
},
"date_in_production_since": "2026-10-08T01:54:13.8874007+00:00",
"date_out_of_production_since": "2026-10-08T01:54:13.8874007+00:00",
"date_end_support": "2026-10-08T01:54:13.8874007+00:00",
"sales_organization_id": "97599835-badb-481e-8e69-0b8438e7c778",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "82196114-b500-4adb-bb71-59e691a6e146",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3fe9be05-033d-4def-ae5f-0e6989b9cbff",
"db_currency_id": "ecca019c-5b7c-4310-b89c-53560fab7cc4",
"db_language_id": "68554da0-4122-4685-9ae4-450aca2b5d28",
"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-08T01:54:13.8874007+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-08T01:54:13.8874007+00:00"
},
"project_status_id": "62384e54-9651-46a5-b34d-0e1f3f0446a2",
"project_status_code": "sample string 10",
"project_status": {
"id": "1e4af1f1-3186-4693-98e6-5ca61ffd133c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2d99b0d5-3cc5-48e8-bf96-4d23ea465318",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "82196114-b500-4adb-bb71-59e691a6e146",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3fe9be05-033d-4def-ae5f-0e6989b9cbff",
"db_currency_id": "ecca019c-5b7c-4310-b89c-53560fab7cc4",
"db_language_id": "68554da0-4122-4685-9ae4-450aca2b5d28",
"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-08T01:54:13.8874007+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-08T01:54:13.8874007+00:00"
},
"company_id": "425e5e82-798c-47ef-bb19-f34177660ef8",
"company_code": "sample string 12",
"db_address_id": "928a243b-1b32-4a5f-9971-9f91ad1d2340",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "44bae444-5178-4f47-a3aa-09e1cd29f8c8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "65b90a51-6d98-4bbc-b59b-1347ef62662e",
"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-08T01:54:13.8874007+00:00",
"date_create": "2026-10-08T01:54:13.8874007+00:00",
"date_update": "2026-10-08T01:54:13.8874007+00:00",
"updated_by_user_id": "1518e1b9-f951-454e-8b78-456f2f7ef3ac",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-08T01:54:13.8874007+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-08T01:54:13.8874007+00:00",
"date_last_job": "2026-10-08T01:54:13.8874007+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-08T01:54:13.8874007+00:00",
"modified_dateutc": "2026-10-08T01:54:13.8874007+00:00",
"is_mobile_installation": true
},
"job_type_id": "f07ab841-a943-4d65-a846-3a44e27d0f7e",
"job_type_code": "sample string 7",
"job_type": {
"id": "91a5c391-4fc1-47cc-a915-435a85e82d92",
"name": "sample string 2",
"sales_organization_id": "588844dd-4323-4e42-b893-6118e442860a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-08T01:54:13.9067586+00:00",
"code": "sample string 7"
},
"job_priority_id": "61899bcc-07ec-4a3e-82c9-b1eaafbae0f1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d1b83c46-e109-490c-b25a-4f340cdbd99b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c754b30e-a9fb-442f-81d5-dd4f3eda5cc3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "82196114-b500-4adb-bb71-59e691a6e146",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3fe9be05-033d-4def-ae5f-0e6989b9cbff",
"db_currency_id": "ecca019c-5b7c-4310-b89c-53560fab7cc4",
"db_language_id": "68554da0-4122-4685-9ae4-450aca2b5d28",
"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-08T01:54:13.8874007+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-08T01:54:13.9067586+00:00"
},
"job_status_id": "343063a0-8710-4fd1-9578-81d6e96c81fb",
"job_status_code": "sample string 11",
"db_address_id": "65a3c790-4661-48b0-9cec-3c368b5c5c2e",
"contact_id": "3aa3b702-41ca-438d-b475-d4a4ae5567bd",
"requested_by_company_id": "241f648e-bfa4-4fc1-a29d-ee53e1ac9d0d",
"requested_by_contact_id": "86d2e9e0-1e01-44c5-a9ad-1d77326e5e05",
"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-08T01:54:13.9067586+00:00",
"due_date": "2026-10-08T01:54:13.9067586+00:00",
"date_create": "2026-10-08T01:54:13.9067586+00:00",
"date_update": "2026-10-08T01:54:13.9067586+00:00",
"date_closed": "2026-10-08T01:54:13.9067586+00:00",
"suggested_user_id": "10b85285-0946-4c64-8edd-95b08b36752a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f2b9567f-edce-4681-ba44-483472af4302",
"db_language_id": "9f5b6fc6-22b3-4a61-b0ee-b40b8b96f3fc",
"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-08T01:54:13.9067586+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "509036e3-a3b6-4f9c-aa77-149703654330",
"sales_organization": {
"id": "82196114-b500-4adb-bb71-59e691a6e146",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3fe9be05-033d-4def-ae5f-0e6989b9cbff",
"db_currency_id": "ecca019c-5b7c-4310-b89c-53560fab7cc4",
"db_language_id": "68554da0-4122-4685-9ae4-450aca2b5d28",
"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-08T01:54:13.8874007+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6d22f917-91d8-4ab9-a4d9-284b7a9ebfd2",
"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": "834bcd0f-ff3d-4518-8184-2ad725ca0f3c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-08T01:54:13.9067586+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "01b57058-3981-48b5-9b7e-8f505ffa2c0c"
},
"suggested_date_start": "2026-10-08T01:54:13.9067586+00:00",
"skill_id": "e07335a1-4e73-487f-bd2c-b315964c69d8",
"skill_code": "sample string 32",
"skill": {
"id": "18dbbc5c-159a-4136-9ae0-baded741a865",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "53239fea-6aac-40c9-8d5e-f5397b12d7d6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "82196114-b500-4adb-bb71-59e691a6e146",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3fe9be05-033d-4def-ae5f-0e6989b9cbff",
"db_currency_id": "ecca019c-5b7c-4310-b89c-53560fab7cc4",
"db_language_id": "68554da0-4122-4685-9ae4-450aca2b5d28",
"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-08T01:54:13.8874007+00:00"
},
"modified_dateutc": "2026-10-08T01:54:13.9067586+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "edb2f519-8f02-4843-aa4d-8e37647b9e7b",
"date_reported_by_company": "2026-10-08T01:54:13.9067586+00:00",
"id2": 36,
"company_id": "5e6c6f01-5076-4d1d-ac37-63adf41f38d5",
"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": "951bfc4c-7910-4964-845f-774bcd1f3a22",
"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-08T01:54:13.9067586+00:00"
},
"work_instruction_details_id": "1626b8e2-c2b4-479d-ba65-c2b117a93a01",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "dca50904-fd10-4229-9c6c-b9efd4d317ff",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f60b509d-057d-48bd-ae2f-966b9d00c499",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-08T01:54:13.9067586+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": "2fc9e6f6-59c3-4977-b9cf-23cbb20d4eeb",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-08T01:54:13.9183966+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.