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": "24558568-2d63-416c-aea8-a9967b7fdbf6",
"jobs_id": "40f20d9b-13c2-4684-8e92-47638390be50",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "658ecf23-b681-4d58-a667-38b8237251a5",
"_parent_id": "0dc47d14-d012-4115-a944-66a9cab03bca",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "50056fd6-f343-4bb2-ace3-d3007e43dc38",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0f9b5f1f-1518-4b27-8147-bdc90e75065c",
"_parent_id": "b681883d-a765-4bbd-8694-81da7fec95b9",
"root_parent_id": "7d97dec1-1dbe-4503-9779-6c303a1a822d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c97f8255-2e92-463e-998d-c780c204268b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "49eb8fc7-2bf6-453b-8423-2d2e684957ad",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c0ac152f-efa6-4d85-a16d-0565f0b650aa",
"_parent_code": "sample string 6",
"sales_organization_id": "6fe6c30c-2da3-4357-88de-dcb6169877cb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "17182e3d-ec63-4fc7-83b9-0776ccc4ce4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14fc6f0a-9a22-483a-8aef-9f0bb322e1d5",
"db_currency_id": "01a9a9b2-909c-4a4f-8d8e-c6128796b3a4",
"db_language_id": "bddcd93b-1c62-4d63-a3a3-6b187dac905b",
"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-06-26T03:37:53.642761+00:00"
},
"modified_dateutc": "2026-06-26T03:37:53.642761+00:00"
},
"equipment_model_id": "8b7bdadf-6b2c-42a9-b387-57db9b07be09",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d34157b9-4dc8-4333-9123-5bbec52f23d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "bbf1877c-c21d-49c0-941c-0bab54aba0ba",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e4e190d6-f9bc-4ca0-9fb8-5aaf16ca5def",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "791e8f72-73ee-4cf1-a4a2-fbe302f5ffe7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "17182e3d-ec63-4fc7-83b9-0776ccc4ce4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14fc6f0a-9a22-483a-8aef-9f0bb322e1d5",
"db_currency_id": "01a9a9b2-909c-4a4f-8d8e-c6128796b3a4",
"db_language_id": "bddcd93b-1c62-4d63-a3a3-6b187dac905b",
"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-06-26T03:37:53.642761+00:00"
},
"modified_dateutc": "2026-06-26T03:37:53.642761+00:00"
},
"equipment_family_id": "166f44d0-6057-4a9d-b591-a425c89cce58",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "49eb8fc7-2bf6-453b-8423-2d2e684957ad",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c0ac152f-efa6-4d85-a16d-0565f0b650aa",
"_parent_code": "sample string 6",
"sales_organization_id": "6fe6c30c-2da3-4357-88de-dcb6169877cb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "17182e3d-ec63-4fc7-83b9-0776ccc4ce4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14fc6f0a-9a22-483a-8aef-9f0bb322e1d5",
"db_currency_id": "01a9a9b2-909c-4a4f-8d8e-c6128796b3a4",
"db_language_id": "bddcd93b-1c62-4d63-a3a3-6b187dac905b",
"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-06-26T03:37:53.642761+00:00"
},
"modified_dateutc": "2026-06-26T03:37:53.642761+00:00"
},
"date_in_production_since": "2026-06-26T03:37:53.642761+00:00",
"date_out_of_production_since": "2026-06-26T03:37:53.642761+00:00",
"date_end_support": "2026-06-26T03:37:53.642761+00:00",
"sales_organization_id": "17e1a9d8-2626-4ba6-9940-e903ecfc430c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "17182e3d-ec63-4fc7-83b9-0776ccc4ce4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14fc6f0a-9a22-483a-8aef-9f0bb322e1d5",
"db_currency_id": "01a9a9b2-909c-4a4f-8d8e-c6128796b3a4",
"db_language_id": "bddcd93b-1c62-4d63-a3a3-6b187dac905b",
"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-06-26T03:37:53.642761+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-06-26T03:37:53.642761+00:00"
},
"project_status_id": "2b979fe1-8345-48a3-be4e-6edd19994d03",
"project_status_code": "sample string 10",
"project_status": {
"id": "a81566da-810f-4b1a-b320-71ede708ab75",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "78def799-9c2a-4a70-ae73-a41d70c9caa9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "17182e3d-ec63-4fc7-83b9-0776ccc4ce4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14fc6f0a-9a22-483a-8aef-9f0bb322e1d5",
"db_currency_id": "01a9a9b2-909c-4a4f-8d8e-c6128796b3a4",
"db_language_id": "bddcd93b-1c62-4d63-a3a3-6b187dac905b",
"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-06-26T03:37:53.642761+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-26T03:37:53.642761+00:00"
},
"company_id": "20a224a3-7aba-4e3c-98e9-f4abc4cbca73",
"company_code": "sample string 12",
"db_address_id": "06122cc7-d8b6-498f-a9fc-5369721eeb4a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3f2c0895-6043-4052-a7de-1c293194c07a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2ba120e0-b454-4bf4-abd1-c6a97590fc5d",
"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-06-26T03:37:53.642761+00:00",
"date_create": "2026-06-26T03:37:53.642761+00:00",
"date_update": "2026-06-26T03:37:53.642761+00:00",
"updated_by_user_id": "28bade10-8418-4cc7-91ba-8c620b0a07f5",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-26T03:37:53.642761+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-06-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-26T03:37:53.642761+00:00",
"date_last_job": "2026-06-26T03:37:53.642761+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-26T03:37:53.642761+00:00",
"modified_dateutc": "2026-06-26T03:37:53.642761+00:00",
"is_mobile_installation": true
},
"job_type_id": "322e9929-b7b0-4728-b745-324207c2d818",
"job_type_code": "sample string 7",
"job_type": {
"id": "0420e116-d569-41b0-aaf0-4af76cf63050",
"name": "sample string 2",
"sales_organization_id": "811a998e-823d-4e30-83af-f7e02a9d028e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-26T03:37:53.642761+00:00",
"code": "sample string 7"
},
"job_priority_id": "49190033-fb4b-4916-8453-4172cfb5db85",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "06d3fbb7-a672-46c6-b587-13bdf57ddac8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "05fb374e-c96d-489b-aee6-c60725f23f59",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "17182e3d-ec63-4fc7-83b9-0776ccc4ce4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14fc6f0a-9a22-483a-8aef-9f0bb322e1d5",
"db_currency_id": "01a9a9b2-909c-4a4f-8d8e-c6128796b3a4",
"db_language_id": "bddcd93b-1c62-4d63-a3a3-6b187dac905b",
"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-06-26T03:37:53.642761+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-26T03:37:53.642761+00:00"
},
"job_status_id": "44cfabd3-8bcc-43b1-9035-1da1c586afc9",
"job_status_code": "sample string 11",
"db_address_id": "c5c36c04-4ac3-4fd5-a0c6-83a2e666104e",
"contact_id": "9e9ae467-2ef5-4b51-83ef-5015bfeeee4b",
"requested_by_company_id": "9d5db93f-a769-489d-9614-f5f8f4f608a0",
"requested_by_contact_id": "9b4f1021-fa3a-4b6d-94ec-079bb6fb36a5",
"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-06-26T03:37:53.642761+00:00",
"due_date": "2026-06-26T03:37:53.642761+00:00",
"date_create": "2026-06-26T03:37:53.642761+00:00",
"date_update": "2026-06-26T03:37:53.642761+00:00",
"date_closed": "2026-06-26T03:37:53.642761+00:00",
"suggested_user_id": "94a30002-d59f-434d-8371-32858ded34eb",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "68d87b4a-8afc-4eea-8cee-37b2dea7bbce",
"db_language_id": "986551ef-1848-4b6a-9361-90ff247f978f",
"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-06-26T03:37:53.642761+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8fa68a75-de7b-4e5f-85a6-6896bc2b1286",
"sales_organization": {
"id": "17182e3d-ec63-4fc7-83b9-0776ccc4ce4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14fc6f0a-9a22-483a-8aef-9f0bb322e1d5",
"db_currency_id": "01a9a9b2-909c-4a4f-8d8e-c6128796b3a4",
"db_language_id": "bddcd93b-1c62-4d63-a3a3-6b187dac905b",
"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-06-26T03:37:53.642761+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c46842cb-b3f5-44a9-851e-2a2e7fd28cd0",
"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": "a8116c13-5e1d-49eb-be08-42a9212b451e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-26T03:37:53.642761+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1ae255df-74a3-4053-aa8a-b19216785415"
},
"suggested_date_start": "2026-06-26T03:37:53.642761+00:00",
"skill_id": "9ccd617f-8c0d-4c36-a27f-3dfeb8486a36",
"skill_code": "sample string 32",
"skill": {
"id": "0f652ab0-c3c0-4de8-885a-1d1991abd29b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2c38df26-4a3e-4aac-9040-9b2641bfc047",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "17182e3d-ec63-4fc7-83b9-0776ccc4ce4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14fc6f0a-9a22-483a-8aef-9f0bb322e1d5",
"db_currency_id": "01a9a9b2-909c-4a4f-8d8e-c6128796b3a4",
"db_language_id": "bddcd93b-1c62-4d63-a3a3-6b187dac905b",
"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-06-26T03:37:53.642761+00:00"
},
"modified_dateutc": "2026-06-26T03:37:53.642761+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "804f0dfa-7f61-415d-860e-7860055e0dcc",
"date_reported_by_company": "2026-06-26T03:37:53.642761+00:00",
"id2": 36,
"company_id": "16163ada-aaf0-4aab-87a1-506aaca81d04",
"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": "8547a010-2bf8-4e85-b662-d2cca76c4252",
"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-06-26T03:37:53.642761+00:00"
},
"work_instruction_details_id": "6f6af0c9-af58-4edc-acb2-22cc8184c796",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "87f26e23-2871-4048-b8ab-418fbb58906d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9fbfd326-964f-400d-931b-5e9907ed6488",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-26T03:37:53.642761+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": "2d1e4518-1665-48db-8e5d-20d99ddcbbd2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-26T03:37:53.642761+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.