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": "8c747e68-a3f3-485a-a8c3-9a4e634db6d7",
"jobs_id": "9e4e1382-7014-4aff-8ad9-52f14d339ed4",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3799765c-4e03-41e7-8b9d-0408c58d7318",
"_parent_id": "9a13f5d6-1b80-469e-8833-70369f41d113",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "69085869-c65e-4a10-96d8-585edc4fd736",
"project_reference_back_office": "sample string 5",
"project": {
"id": "76beee86-8fe4-43f0-be63-5a806f3343cd",
"_parent_id": "ef115f81-7184-42b2-a24e-7d56a607d0a3",
"root_parent_id": "bbcab677-de30-4748-b272-18958e9b75a4",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "000bd99e-4dcc-4ab9-a006-f08f8c1bd84c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "aff0b9bb-cf56-4275-b70a-05c66b428233",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "26fe2183-7f1d-46cf-808a-f473c19a72c9",
"_parent_code": "sample string 6",
"sales_organization_id": "cb967b20-211a-4940-a20f-47b92ca5994f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "eba372fe-44a6-4d20-96b2-214514a9ecfc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fedf93bc-78a8-4dd2-ae55-c3e4f5aeea61",
"db_currency_id": "00d0b65e-4064-408d-ba2e-77afcc97a74c",
"db_language_id": "bcbeef99-48e1-4bc8-86d3-3e07ef2b010d",
"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-07-12T00:38:18.2846256+00:00"
},
"modified_dateutc": "2026-07-12T00:38:18.2846256+00:00"
},
"equipment_model_id": "d73bc1c0-2940-47d9-a866-5c2f3d7ceb1b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "53f4a1e5-21f0-44a3-a14f-f58d6a911fca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "fc0637e3-645c-44c6-acd1-4fae5acd481e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1dff6293-fd57-4e6e-a131-1c355e395f36",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a2411e00-38bf-4699-a2b8-95bf8d1fd3b3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "eba372fe-44a6-4d20-96b2-214514a9ecfc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fedf93bc-78a8-4dd2-ae55-c3e4f5aeea61",
"db_currency_id": "00d0b65e-4064-408d-ba2e-77afcc97a74c",
"db_language_id": "bcbeef99-48e1-4bc8-86d3-3e07ef2b010d",
"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-07-12T00:38:18.2846256+00:00"
},
"modified_dateutc": "2026-07-12T00:38:18.2846256+00:00"
},
"equipment_family_id": "9ad4228d-202c-4886-a82d-cd466ca30b0b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "aff0b9bb-cf56-4275-b70a-05c66b428233",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "26fe2183-7f1d-46cf-808a-f473c19a72c9",
"_parent_code": "sample string 6",
"sales_organization_id": "cb967b20-211a-4940-a20f-47b92ca5994f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "eba372fe-44a6-4d20-96b2-214514a9ecfc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fedf93bc-78a8-4dd2-ae55-c3e4f5aeea61",
"db_currency_id": "00d0b65e-4064-408d-ba2e-77afcc97a74c",
"db_language_id": "bcbeef99-48e1-4bc8-86d3-3e07ef2b010d",
"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-07-12T00:38:18.2846256+00:00"
},
"modified_dateutc": "2026-07-12T00:38:18.2846256+00:00"
},
"date_in_production_since": "2026-07-12T00:38:18.2846256+00:00",
"date_out_of_production_since": "2026-07-12T00:38:18.2846256+00:00",
"date_end_support": "2026-07-12T00:38:18.2846256+00:00",
"sales_organization_id": "face0d2a-5544-4c0c-87e4-8206d52837e8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "eba372fe-44a6-4d20-96b2-214514a9ecfc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fedf93bc-78a8-4dd2-ae55-c3e4f5aeea61",
"db_currency_id": "00d0b65e-4064-408d-ba2e-77afcc97a74c",
"db_language_id": "bcbeef99-48e1-4bc8-86d3-3e07ef2b010d",
"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-07-12T00:38:18.2846256+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-07-12T00:38:18.2846256+00:00"
},
"project_status_id": "6cf9a247-81ef-4252-894a-07b0ee020ec4",
"project_status_code": "sample string 10",
"project_status": {
"id": "365abdc5-011f-44eb-a84a-86e8f0d01f35",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a47c0452-ba8b-41c4-94ea-db2bcec6ad07",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eba372fe-44a6-4d20-96b2-214514a9ecfc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fedf93bc-78a8-4dd2-ae55-c3e4f5aeea61",
"db_currency_id": "00d0b65e-4064-408d-ba2e-77afcc97a74c",
"db_language_id": "bcbeef99-48e1-4bc8-86d3-3e07ef2b010d",
"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-07-12T00:38:18.2846256+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-12T00:38:18.2846256+00:00"
},
"company_id": "8e0ebfd4-3d27-4fa1-b225-f37fb334a859",
"company_code": "sample string 12",
"db_address_id": "2fbb8163-6a12-484e-b046-84e42ca61ab1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "65844276-d4ca-4e6e-ab2e-c8c7a9d539ed",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "636afd52-902e-4d4b-8234-8418846f4378",
"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-07-12T00:38:18.30025+00:00",
"date_create": "2026-07-12T00:38:18.30025+00:00",
"date_update": "2026-07-12T00:38:18.30025+00:00",
"updated_by_user_id": "62f5d2d4-b5e9-4481-abe2-7382303ae1c0",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-12T00:38:18.30025+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-07-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-12T00:38:18.30025+00:00",
"date_last_job": "2026-07-12T00:38:18.30025+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-12T00:38:18.30025+00:00",
"modified_dateutc": "2026-07-12T00:38:18.30025+00:00",
"is_mobile_installation": true
},
"job_type_id": "1e9ad535-8a04-4121-9ccb-0e0914cd8cae",
"job_type_code": "sample string 7",
"job_type": {
"id": "05e3baeb-8b06-4f99-bff1-93b7d91beea4",
"name": "sample string 2",
"sales_organization_id": "fbe458c0-ecd8-40e7-9394-4db5d2a9bb3a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-12T00:38:18.30025+00:00",
"code": "sample string 7"
},
"job_priority_id": "78622909-5ad2-442a-9627-463d238b5a3b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "53b23821-3a99-4a86-a9b8-644c3908869a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9ee6f4d3-a38c-4a9f-9874-46efc637d8ef",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eba372fe-44a6-4d20-96b2-214514a9ecfc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fedf93bc-78a8-4dd2-ae55-c3e4f5aeea61",
"db_currency_id": "00d0b65e-4064-408d-ba2e-77afcc97a74c",
"db_language_id": "bcbeef99-48e1-4bc8-86d3-3e07ef2b010d",
"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-07-12T00:38:18.2846256+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-12T00:38:18.30025+00:00"
},
"job_status_id": "e667d7cf-d0e1-4a03-95ab-8913f5ecd02b",
"job_status_code": "sample string 11",
"db_address_id": "2fb3c3f7-b01e-472d-94d9-8467467de081",
"contact_id": "e3a74ca6-f45f-47e9-9448-44e9be2bbc33",
"requested_by_company_id": "fec57d04-879f-4979-aa6a-691785e2ebb6",
"requested_by_contact_id": "4278eb5b-5f3b-4051-ae6d-cae955b4d25d",
"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-07-12T00:38:18.30025+00:00",
"due_date": "2026-07-12T00:38:18.30025+00:00",
"date_create": "2026-07-12T00:38:18.30025+00:00",
"date_update": "2026-07-12T00:38:18.30025+00:00",
"date_closed": "2026-07-12T00:38:18.30025+00:00",
"suggested_user_id": "dcf80064-4fd2-469c-a932-78ad98164868",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "cbc44895-0c19-4916-9df1-f3d0ee718f1c",
"db_language_id": "c38b4975-c3fa-4f95-a818-a97a1fedec59",
"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-07-12T00:38:18.30025+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "26b0b49c-4f48-4f54-8c8d-19a75510b8e4",
"sales_organization": {
"id": "eba372fe-44a6-4d20-96b2-214514a9ecfc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fedf93bc-78a8-4dd2-ae55-c3e4f5aeea61",
"db_currency_id": "00d0b65e-4064-408d-ba2e-77afcc97a74c",
"db_language_id": "bcbeef99-48e1-4bc8-86d3-3e07ef2b010d",
"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-07-12T00:38:18.2846256+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "bf1e99d1-9d52-400d-9845-e1e726501926",
"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": "6035d090-9868-490d-8b01-95eac3b74733",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-12T00:38:18.30025+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d7e08b6a-81c7-49d5-86c0-5b46f872289b"
},
"suggested_date_start": "2026-07-12T00:38:18.30025+00:00",
"skill_id": "e61c7ac3-8d0d-4fc5-857e-380aa74f6010",
"skill_code": "sample string 32",
"skill": {
"id": "242a66a2-97b5-4f50-83a4-554ff2b23638",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d147be40-d1c7-48d3-acfe-ac532ead3369",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eba372fe-44a6-4d20-96b2-214514a9ecfc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fedf93bc-78a8-4dd2-ae55-c3e4f5aeea61",
"db_currency_id": "00d0b65e-4064-408d-ba2e-77afcc97a74c",
"db_language_id": "bcbeef99-48e1-4bc8-86d3-3e07ef2b010d",
"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-07-12T00:38:18.2846256+00:00"
},
"modified_dateutc": "2026-07-12T00:38:18.30025+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1af5f70a-6947-4151-8708-afb369dd19da",
"date_reported_by_company": "2026-07-12T00:38:18.30025+00:00",
"id2": 36,
"company_id": "8d18465b-8981-4fe8-acdf-d8871f785b93",
"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": "2b98873a-e29e-4c64-9465-6cf6a18ad39e",
"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-07-12T00:38:18.30025+00:00"
},
"work_instruction_details_id": "2805864e-682a-43b2-8877-5099d04b7de0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6cbf5694-345d-4ffd-8b8c-bf6cd914312a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8afee02a-74dc-4095-9b6b-9fa97ee9e887",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-12T00:38:18.30025+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": "7097aec2-e3ab-40b2-b6d4-1424630f0279",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-12T00:38:18.30025+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.