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": "ea9538b7-1f38-49b5-9b43-6292a88783fb",
"jobs_id": "d77b4003-29f7-49a8-a5f7-49b038e2333e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "990895fa-68e6-4708-8a6e-96ee5128aa75",
"_parent_id": "2b7e8085-d825-4166-b587-5c145289397b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "93111cc9-cf39-4ac1-a14e-b5cd9b6ce69d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "da436020-7e7f-489d-90b3-3962b7a6099b",
"_parent_id": "2f2de343-f88b-4432-ab93-b2ec49a4b850",
"root_parent_id": "000a7ca4-3741-45f0-94e5-bb28ca086c7a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2aa14b97-a5cf-4f17-8944-c9d663ee3f6d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3f536fd6-499c-4454-ab83-c683aa4e4934",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bb39657f-3aa4-4147-8388-1e07160606fe",
"_parent_code": "sample string 6",
"sales_organization_id": "404bbb65-7a29-458c-b42d-ed88152ab10c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "945052f0-3aae-4323-9193-3f15c257faaa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4cfcc0e7-fea1-4fdc-a287-4d7006082bdd",
"db_currency_id": "82ba41ba-effc-4760-b270-e69dccd7a0a7",
"db_language_id": "67535d3a-458a-41ec-b42c-9681c116109c",
"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-02-05T11:04:58.1423835+00:00"
},
"modified_dateutc": "2026-02-05T11:04:58.1423835+00:00"
},
"equipment_model_id": "e3c16564-fca0-468b-ac0b-20bba9c4b5ce",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "21cb1e71-7382-42e5-8edc-975abd427f5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0b5fefc4-5bfc-4f90-9255-24f970313e93",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9b48407e-6266-41b0-9db9-6495e2fc9b24",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "cac6ac26-c97e-40c2-94d3-0044969804dd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "945052f0-3aae-4323-9193-3f15c257faaa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4cfcc0e7-fea1-4fdc-a287-4d7006082bdd",
"db_currency_id": "82ba41ba-effc-4760-b270-e69dccd7a0a7",
"db_language_id": "67535d3a-458a-41ec-b42c-9681c116109c",
"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-02-05T11:04:58.1423835+00:00"
},
"modified_dateutc": "2026-02-05T11:04:58.1423835+00:00"
},
"equipment_family_id": "8a1bca93-2297-4ba8-92f4-ad5f32cc9c6a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3f536fd6-499c-4454-ab83-c683aa4e4934",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bb39657f-3aa4-4147-8388-1e07160606fe",
"_parent_code": "sample string 6",
"sales_organization_id": "404bbb65-7a29-458c-b42d-ed88152ab10c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "945052f0-3aae-4323-9193-3f15c257faaa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4cfcc0e7-fea1-4fdc-a287-4d7006082bdd",
"db_currency_id": "82ba41ba-effc-4760-b270-e69dccd7a0a7",
"db_language_id": "67535d3a-458a-41ec-b42c-9681c116109c",
"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-02-05T11:04:58.1423835+00:00"
},
"modified_dateutc": "2026-02-05T11:04:58.1423835+00:00"
},
"date_in_production_since": "2026-02-05T11:04:58.1423835+00:00",
"date_out_of_production_since": "2026-02-05T11:04:58.1423835+00:00",
"date_end_support": "2026-02-05T11:04:58.1423835+00:00",
"sales_organization_id": "01477ce9-50e7-45ac-8141-e9cc1cefc860",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "945052f0-3aae-4323-9193-3f15c257faaa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4cfcc0e7-fea1-4fdc-a287-4d7006082bdd",
"db_currency_id": "82ba41ba-effc-4760-b270-e69dccd7a0a7",
"db_language_id": "67535d3a-458a-41ec-b42c-9681c116109c",
"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-02-05T11:04:58.1423835+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-02-05T11:04:58.1580077+00:00"
},
"project_status_id": "41d06e97-546e-4b1e-9c27-46be46409254",
"project_status_code": "sample string 10",
"project_status": {
"id": "c98f7210-24e1-4d2e-b9d5-64d516cf2f39",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d92ba165-ac6f-462a-a30d-740bee42403c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "945052f0-3aae-4323-9193-3f15c257faaa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4cfcc0e7-fea1-4fdc-a287-4d7006082bdd",
"db_currency_id": "82ba41ba-effc-4760-b270-e69dccd7a0a7",
"db_language_id": "67535d3a-458a-41ec-b42c-9681c116109c",
"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-02-05T11:04:58.1423835+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-05T11:04:58.1580077+00:00"
},
"company_id": "d3cb112e-2b4d-4dcf-809f-1bf45ce41258",
"company_code": "sample string 12",
"db_address_id": "5460264b-da99-41de-9abe-a9d2b8c32b06",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ea5efeb1-8815-418a-bfa6-496918bd1ec7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1ca0e018-144b-44fa-b9ea-032a25918be1",
"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-02-05T11:04:58.1580077+00:00",
"date_create": "2026-02-05T11:04:58.1580077+00:00",
"date_update": "2026-02-05T11:04:58.1580077+00:00",
"updated_by_user_id": "0e4bda3b-7322-4aea-b11b-992a4fd292b1",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-05T11:04:58.1580077+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-02-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-05T11:04:58.1580077+00:00",
"date_last_job": "2026-02-05T11:04:58.1580077+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-05T11:04:58.1580077+00:00",
"modified_dateutc": "2026-02-05T11:04:58.1580077+00:00",
"is_mobile_installation": true
},
"job_type_id": "4833cb5b-dd26-4fa9-89a8-e0e42a2864fa",
"job_type_code": "sample string 7",
"job_type": {
"id": "c103e28e-f5bf-4e3b-b016-413df859133c",
"name": "sample string 2",
"sales_organization_id": "143b2763-61cc-475c-a7cf-fd0d3e2b8da9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-05T11:04:58.1580077+00:00",
"code": "sample string 7"
},
"job_priority_id": "75d7780f-592a-414d-b3a7-c3b3fd32d2cb",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4102bdd6-c764-40f6-823f-8877ac134542",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1c14e67e-0288-4cb2-8df5-e34e3a9a9c55",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "945052f0-3aae-4323-9193-3f15c257faaa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4cfcc0e7-fea1-4fdc-a287-4d7006082bdd",
"db_currency_id": "82ba41ba-effc-4760-b270-e69dccd7a0a7",
"db_language_id": "67535d3a-458a-41ec-b42c-9681c116109c",
"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-02-05T11:04:58.1423835+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-05T11:04:58.1580077+00:00"
},
"job_status_id": "fe01a70f-16b5-4d93-a3e7-92049382de36",
"job_status_code": "sample string 11",
"db_address_id": "15d9f654-494e-4539-8867-25d0bd5f37dc",
"contact_id": "09751089-6933-4c4a-886f-88d640c3645a",
"requested_by_company_id": "98679c4a-88e7-4440-be5c-9a154a2933c3",
"requested_by_contact_id": "0582d679-0a84-4abe-9ee2-22558ca1f07d",
"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-02-05T11:04:58.1580077+00:00",
"due_date": "2026-02-05T11:04:58.1580077+00:00",
"date_create": "2026-02-05T11:04:58.1580077+00:00",
"date_update": "2026-02-05T11:04:58.1580077+00:00",
"date_closed": "2026-02-05T11:04:58.1580077+00:00",
"suggested_user_id": "5bd94ac4-a278-4c6e-8b7f-d4f13a6d1fbd",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7cbc631e-d163-4641-9599-47f5e168b5c9",
"db_language_id": "4e0033a7-15a7-4771-8828-4ca8fb036927",
"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-02-05T11:04:58.1580077+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "aee4f6b0-d614-4ccd-8b3a-518e827e0ff1",
"sales_organization": {
"id": "945052f0-3aae-4323-9193-3f15c257faaa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4cfcc0e7-fea1-4fdc-a287-4d7006082bdd",
"db_currency_id": "82ba41ba-effc-4760-b270-e69dccd7a0a7",
"db_language_id": "67535d3a-458a-41ec-b42c-9681c116109c",
"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-02-05T11:04:58.1423835+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "30cd7b2f-1359-421f-b37f-b8003da1bddf",
"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": "5e8bc6d9-eed0-4d07-9c93-b68197643e21",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-05T11:04:58.1580077+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c75efe0a-25f2-481c-957e-25a41103d993"
},
"suggested_date_start": "2026-02-05T11:04:58.1580077+00:00",
"skill_id": "bd06ab34-389c-400e-912c-13d18d1d8709",
"skill_code": "sample string 32",
"skill": {
"id": "94804225-571e-4547-8c02-cc82b7a9ad45",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "af3bf3f2-10a1-4723-bd2c-7d558164120c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "945052f0-3aae-4323-9193-3f15c257faaa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4cfcc0e7-fea1-4fdc-a287-4d7006082bdd",
"db_currency_id": "82ba41ba-effc-4760-b270-e69dccd7a0a7",
"db_language_id": "67535d3a-458a-41ec-b42c-9681c116109c",
"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-02-05T11:04:58.1423835+00:00"
},
"modified_dateutc": "2026-02-05T11:04:58.1580077+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ccfbd91e-a80c-494d-9d67-fceb48594200",
"date_reported_by_company": "2026-02-05T11:04:58.1580077+00:00",
"id2": 36,
"company_id": "5e73cd0f-88cc-464d-8866-5ef6acaebb3f",
"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": "9dd09213-a9f9-49b9-b6eb-c996317b32d5",
"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-02-05T11:04:58.1580077+00:00"
},
"work_instruction_details_id": "a0fcee96-aa25-4b18-a7c6-185737daa279",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e0fa4798-42e6-45ab-a094-ffbec01e99b7",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c85f0a13-934e-464b-8797-3d70e00a2559",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-05T11:04:58.1580077+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": "47939d11-a749-4062-8040-9812074797bb",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-05T11:04:58.1580077+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.