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": "5eb87f81-9388-4115-9ce1-e98612bf2c43",
"jobs_id": "93cf1e81-09b2-423f-9f69-d4a0aa39fae6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a1edf4ab-a672-42c1-94b6-b2da18fdfb9c",
"_parent_id": "de866378-8099-4f97-9c7b-39dbac8dc02a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c948f7eb-f3d0-4b0e-a585-f25d0b2a6da6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "88f4132b-0bbb-4174-a7fa-dbbf81898947",
"_parent_id": "1fb9e043-a8fe-4ffe-b709-360fc0b081d5",
"root_parent_id": "24b603ac-929b-4437-97bd-08933e4fd39d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9457bcb4-a3b6-4942-ab0c-efd19eb03a3a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0ff8acea-b561-4211-9010-b04940d4fb6a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b8fa2778-cecc-4d71-8cb5-7f10f25a04c5",
"_parent_code": "sample string 6",
"sales_organization_id": "b4c27e66-c8d5-4aa8-9507-01c5dbe16bc5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1521ea18-db8a-43a8-aeac-1ffbfc1ec4a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d21accec-8621-4b46-81ad-e1b48ffb58c3",
"db_currency_id": "6d644185-f79b-4e42-93d2-6c12a756cf41",
"db_language_id": "95fcd3f8-5147-4ac3-b35c-67f57cddcca6",
"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-12-23T08:11:42.7932302+00:00"
},
"modified_dateutc": "2025-12-23T08:11:42.7932302+00:00"
},
"equipment_model_id": "e513b513-e05c-4b63-a679-9c09faceda47",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5b6bf972-e09b-4489-a515-ce58ed66f3af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "84388f1e-a4c6-4159-aa62-36713d18d9c8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c3ffb18f-c057-4035-a5fb-67bd399c7143",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5f9975b8-d584-4200-a1ba-2875cb7f7990",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1521ea18-db8a-43a8-aeac-1ffbfc1ec4a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d21accec-8621-4b46-81ad-e1b48ffb58c3",
"db_currency_id": "6d644185-f79b-4e42-93d2-6c12a756cf41",
"db_language_id": "95fcd3f8-5147-4ac3-b35c-67f57cddcca6",
"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-12-23T08:11:42.7932302+00:00"
},
"modified_dateutc": "2025-12-23T08:11:42.7932302+00:00"
},
"equipment_family_id": "6ffe24d8-b1e7-4d61-aa38-45c6d180fd67",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0ff8acea-b561-4211-9010-b04940d4fb6a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b8fa2778-cecc-4d71-8cb5-7f10f25a04c5",
"_parent_code": "sample string 6",
"sales_organization_id": "b4c27e66-c8d5-4aa8-9507-01c5dbe16bc5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1521ea18-db8a-43a8-aeac-1ffbfc1ec4a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d21accec-8621-4b46-81ad-e1b48ffb58c3",
"db_currency_id": "6d644185-f79b-4e42-93d2-6c12a756cf41",
"db_language_id": "95fcd3f8-5147-4ac3-b35c-67f57cddcca6",
"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-12-23T08:11:42.7932302+00:00"
},
"modified_dateutc": "2025-12-23T08:11:42.7932302+00:00"
},
"date_in_production_since": "2025-12-23T08:11:42.7932302+00:00",
"date_out_of_production_since": "2025-12-23T08:11:42.7932302+00:00",
"date_end_support": "2025-12-23T08:11:42.7932302+00:00",
"sales_organization_id": "3c5d3589-3f50-42b7-a07f-50b856639735",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1521ea18-db8a-43a8-aeac-1ffbfc1ec4a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d21accec-8621-4b46-81ad-e1b48ffb58c3",
"db_currency_id": "6d644185-f79b-4e42-93d2-6c12a756cf41",
"db_language_id": "95fcd3f8-5147-4ac3-b35c-67f57cddcca6",
"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-12-23T08:11:42.7932302+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-12-23T08:11:42.7932302+00:00"
},
"project_status_id": "763adc91-3f4e-4182-a18e-089920ef56d5",
"project_status_code": "sample string 10",
"project_status": {
"id": "ed565437-7ce5-40c6-a00e-72af84bbc330",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4ffbbfba-8d5d-4833-b88a-47e252fe8489",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1521ea18-db8a-43a8-aeac-1ffbfc1ec4a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d21accec-8621-4b46-81ad-e1b48ffb58c3",
"db_currency_id": "6d644185-f79b-4e42-93d2-6c12a756cf41",
"db_language_id": "95fcd3f8-5147-4ac3-b35c-67f57cddcca6",
"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-12-23T08:11:42.7932302+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-23T08:11:42.7932302+00:00"
},
"company_id": "6d783674-39d1-40b6-b136-25e7ffce468f",
"company_code": "sample string 12",
"db_address_id": "cd0d4b5b-914e-4fd7-833c-edd3829c9197",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a9451685-0c47-4ab5-a66a-e3eadb6a9087",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "51c3a902-aa39-47a5-998c-728c4f2ac244",
"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-12-23T08:11:42.7932302+00:00",
"date_create": "2025-12-23T08:11:42.7932302+00:00",
"date_update": "2025-12-23T08:11:42.7932302+00:00",
"updated_by_user_id": "3ed3c260-55a8-41ba-87e5-ed2092969bb6",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-23T08:11:42.7932302+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-12-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-23T08:11:42.7932302+00:00",
"date_last_job": "2025-12-23T08:11:42.7932302+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-23T08:11:42.7932302+00:00",
"modified_dateutc": "2025-12-23T08:11:42.7932302+00:00",
"is_mobile_installation": true
},
"job_type_id": "aae9f893-0eed-411c-a7b1-e2a7c4f8f95a",
"job_type_code": "sample string 7",
"job_type": {
"id": "64f56ebf-82a4-4799-b219-724d6cab3a8e",
"name": "sample string 2",
"sales_organization_id": "3544280f-10ad-41fe-a536-3bc25d3a342a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-23T08:11:42.7932302+00:00",
"code": "sample string 7"
},
"job_priority_id": "892ad70a-a90c-4252-80aa-4e16f6e8459f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "dc491e17-44d8-44fa-b956-4fd9d6e4786b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "83e441ee-4a44-4abe-ba59-f43e29e3380b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1521ea18-db8a-43a8-aeac-1ffbfc1ec4a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d21accec-8621-4b46-81ad-e1b48ffb58c3",
"db_currency_id": "6d644185-f79b-4e42-93d2-6c12a756cf41",
"db_language_id": "95fcd3f8-5147-4ac3-b35c-67f57cddcca6",
"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-12-23T08:11:42.7932302+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-23T08:11:42.7932302+00:00"
},
"job_status_id": "6297781a-23b8-4b15-bec1-b97af53b4855",
"job_status_code": "sample string 11",
"db_address_id": "1fb48688-eb7e-40b6-a24b-5de6f3a69380",
"contact_id": "e928d5d7-4cb4-40db-b56f-221558f17e89",
"requested_by_company_id": "13290b98-e0cc-4f37-b8b4-44f2ea766cc7",
"requested_by_contact_id": "6be721f9-1adf-4215-856c-9e9151de2330",
"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-12-23T08:11:42.7932302+00:00",
"due_date": "2025-12-23T08:11:42.7932302+00:00",
"date_create": "2025-12-23T08:11:42.7932302+00:00",
"date_update": "2025-12-23T08:11:42.7932302+00:00",
"date_closed": "2025-12-23T08:11:42.7932302+00:00",
"suggested_user_id": "724f618b-9078-4707-90a4-328e9e82d040",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0f4f5bd6-ad9a-4443-b8fd-77ee4839ee07",
"db_language_id": "a3188087-10ec-4456-b72d-c78abbfd0642",
"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-12-23T08:11:42.7932302+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3e0a524b-cd54-40bc-9ce4-c15b5a5f218f",
"sales_organization": {
"id": "1521ea18-db8a-43a8-aeac-1ffbfc1ec4a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d21accec-8621-4b46-81ad-e1b48ffb58c3",
"db_currency_id": "6d644185-f79b-4e42-93d2-6c12a756cf41",
"db_language_id": "95fcd3f8-5147-4ac3-b35c-67f57cddcca6",
"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-12-23T08:11:42.7932302+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "93d75bf0-c82e-4757-94d3-c93b9f385970",
"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": "51656b48-dba2-4f04-b177-dd9666853e05",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-23T08:11:42.7932302+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "cf918b54-a4d8-492c-9c40-1b27c31b4b1a"
},
"suggested_date_start": "2025-12-23T08:11:42.7932302+00:00",
"skill_id": "73f71894-8c20-480b-baa8-946f2fc6d65b",
"skill_code": "sample string 32",
"skill": {
"id": "70af6eb4-1bb2-409c-ae5d-dc1ef23e37d5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "54f312f0-7eba-4dc5-990a-a2f3a45c67ed",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1521ea18-db8a-43a8-aeac-1ffbfc1ec4a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d21accec-8621-4b46-81ad-e1b48ffb58c3",
"db_currency_id": "6d644185-f79b-4e42-93d2-6c12a756cf41",
"db_language_id": "95fcd3f8-5147-4ac3-b35c-67f57cddcca6",
"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-12-23T08:11:42.7932302+00:00"
},
"modified_dateutc": "2025-12-23T08:11:42.7932302+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b0d72ecf-c9e0-4956-bb32-7c6fde5128d7",
"date_reported_by_company": "2025-12-23T08:11:42.7932302+00:00",
"id2": 36,
"company_id": "7f0c7e73-9357-43c6-bc3b-a69ecf250069",
"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": "8443984d-4763-407f-905f-28b4fe1e8664",
"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-12-23T08:11:42.7932302+00:00"
},
"work_instruction_details_id": "53bc5147-6162-4dd7-932e-f094b68fcb3e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c4050877-8a13-4526-96d8-a219930af751",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "31dc51bc-05fd-4b2a-815f-6ed8ee67edd6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-23T08:11:42.7932302+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": "66da7414-f0d2-48b7-b90f-2b17b7f887da",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-23T08:11:42.7932302+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.