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": "0e8db5e7-8460-4046-9202-bb83819df89e",
"jobs_id": "4214ee87-3e38-41d0-8cc0-591a50b61676",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "518508fa-44fc-465a-bc2a-3770073318d8",
"_parent_id": "c6401cd7-b19e-45a9-9c62-0096fda55195",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "403f1173-c981-47c6-b2ed-26c9b584a93d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "44cfefff-9f9c-4710-ab1f-8efed9606af4",
"_parent_id": "a9c143b9-011f-4684-b9dc-a4f660b21bc8",
"root_parent_id": "55cae3c6-468f-4a86-9b19-8644b63f617c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4f6dfca9-27e0-45cf-b5d9-661f6bc95b02",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d967df32-6305-467d-ab3c-4f9b2e6fb58a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f2c5e1ba-f500-425b-88a5-2c099f205eb7",
"_parent_code": "sample string 6",
"sales_organization_id": "84d5c6e0-b4de-466d-b1be-1282b736e0b5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "01dba256-a90e-40ff-bf3c-1246df6bd32c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb9f6323-e51c-4ae7-bb26-c991996a841e",
"db_currency_id": "0610eeef-32b0-499e-aed4-f7acb97b4a4b",
"db_language_id": "ae90b602-e529-4d8e-ac5d-ae8c0110f0c1",
"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-21T02:18:26.7035741+00:00"
},
"modified_dateutc": "2026-06-21T02:18:26.7035741+00:00"
},
"equipment_model_id": "0c7b2492-0ef9-4525-b201-e52524174919",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "582ff28c-370c-44c4-a37c-1ea817247b50",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0a5d8c6a-889f-4dfb-88f6-8037fea5c2a7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "81420dc1-b93b-46b7-8162-9bbd4090909e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "46b7b7c3-10e2-4b8f-8a7f-fd6aacb09791",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "01dba256-a90e-40ff-bf3c-1246df6bd32c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb9f6323-e51c-4ae7-bb26-c991996a841e",
"db_currency_id": "0610eeef-32b0-499e-aed4-f7acb97b4a4b",
"db_language_id": "ae90b602-e529-4d8e-ac5d-ae8c0110f0c1",
"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-21T02:18:26.7035741+00:00"
},
"modified_dateutc": "2026-06-21T02:18:26.7035741+00:00"
},
"equipment_family_id": "c0a976f4-a3fb-4852-8ae6-28b52a8a2f92",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d967df32-6305-467d-ab3c-4f9b2e6fb58a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f2c5e1ba-f500-425b-88a5-2c099f205eb7",
"_parent_code": "sample string 6",
"sales_organization_id": "84d5c6e0-b4de-466d-b1be-1282b736e0b5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "01dba256-a90e-40ff-bf3c-1246df6bd32c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb9f6323-e51c-4ae7-bb26-c991996a841e",
"db_currency_id": "0610eeef-32b0-499e-aed4-f7acb97b4a4b",
"db_language_id": "ae90b602-e529-4d8e-ac5d-ae8c0110f0c1",
"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-21T02:18:26.7035741+00:00"
},
"modified_dateutc": "2026-06-21T02:18:26.7035741+00:00"
},
"date_in_production_since": "2026-06-21T02:18:26.7035741+00:00",
"date_out_of_production_since": "2026-06-21T02:18:26.7035741+00:00",
"date_end_support": "2026-06-21T02:18:26.7035741+00:00",
"sales_organization_id": "0536bf9b-8287-441b-8577-75315e7a052b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "01dba256-a90e-40ff-bf3c-1246df6bd32c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb9f6323-e51c-4ae7-bb26-c991996a841e",
"db_currency_id": "0610eeef-32b0-499e-aed4-f7acb97b4a4b",
"db_language_id": "ae90b602-e529-4d8e-ac5d-ae8c0110f0c1",
"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-21T02:18:26.7035741+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-21T02:18:26.7035741+00:00"
},
"project_status_id": "8c209f1f-0cca-4e89-8659-5fc47b40eebf",
"project_status_code": "sample string 10",
"project_status": {
"id": "25f669ad-92c6-4ebc-8136-cb114e544474",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a53d89c4-54a2-4785-a75a-967124ff1f94",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "01dba256-a90e-40ff-bf3c-1246df6bd32c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb9f6323-e51c-4ae7-bb26-c991996a841e",
"db_currency_id": "0610eeef-32b0-499e-aed4-f7acb97b4a4b",
"db_language_id": "ae90b602-e529-4d8e-ac5d-ae8c0110f0c1",
"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-21T02:18:26.7035741+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-21T02:18:26.7035741+00:00"
},
"company_id": "eaf8a37d-873f-49b9-b8c0-0aa4cd8673ff",
"company_code": "sample string 12",
"db_address_id": "89296369-0523-4910-8bfd-38420af98b1f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b6df0998-bd20-4f9d-9b86-fdcd7e0548e9",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "eed84392-793a-4b7a-a5d0-10fd81d742d0",
"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-21T02:18:26.7035741+00:00",
"date_create": "2026-06-21T02:18:26.7035741+00:00",
"date_update": "2026-06-21T02:18:26.7035741+00:00",
"updated_by_user_id": "147b2b28-1324-4b24-a20e-245903598248",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-21T02:18:26.7035741+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-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-21T02:18:26.7035741+00:00",
"date_last_job": "2026-06-21T02:18:26.7035741+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-21T02:18:26.7035741+00:00",
"modified_dateutc": "2026-06-21T02:18:26.7035741+00:00",
"is_mobile_installation": true
},
"job_type_id": "a27ba711-7850-4259-97c8-16e7b38253e1",
"job_type_code": "sample string 7",
"job_type": {
"id": "c3af8ae9-d90a-4ab0-a7e5-045bea263a6c",
"name": "sample string 2",
"sales_organization_id": "cbad7f23-857b-4880-8027-205f2a7122ab",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-21T02:18:26.7035741+00:00",
"code": "sample string 7"
},
"job_priority_id": "48d21379-d55b-4e33-8a06-baac71e28372",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a9600f09-ebf1-436d-80da-c3a3a70353e9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "14aca90a-5213-4153-bf92-a4a64bbf5a2c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "01dba256-a90e-40ff-bf3c-1246df6bd32c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb9f6323-e51c-4ae7-bb26-c991996a841e",
"db_currency_id": "0610eeef-32b0-499e-aed4-f7acb97b4a4b",
"db_language_id": "ae90b602-e529-4d8e-ac5d-ae8c0110f0c1",
"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-21T02:18:26.7035741+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-21T02:18:26.7035741+00:00"
},
"job_status_id": "54bae9f1-60bd-4f58-93bb-d31737fbee99",
"job_status_code": "sample string 11",
"db_address_id": "0a8c0905-fab6-448f-a124-1af033fa3135",
"contact_id": "9be5b8df-01b2-45ab-b647-7f92a1ede8f5",
"requested_by_company_id": "49660a6f-e0fb-4853-8b6b-8dd010099954",
"requested_by_contact_id": "4832aa5f-e953-4109-b444-b4801e1b0847",
"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-21T02:18:26.7035741+00:00",
"due_date": "2026-06-21T02:18:26.7035741+00:00",
"date_create": "2026-06-21T02:18:26.7035741+00:00",
"date_update": "2026-06-21T02:18:26.7035741+00:00",
"date_closed": "2026-06-21T02:18:26.7035741+00:00",
"suggested_user_id": "8565287b-a4c4-4450-b706-85d1d23cce0f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c1883e31-a03c-4273-be76-216f59b4ccd5",
"db_language_id": "6b3a5856-c72a-4160-97b7-01c1a2d26102",
"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-21T02:18:26.7035741+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "84ee0597-50ac-436f-a6f5-1f27d9961794",
"sales_organization": {
"id": "01dba256-a90e-40ff-bf3c-1246df6bd32c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb9f6323-e51c-4ae7-bb26-c991996a841e",
"db_currency_id": "0610eeef-32b0-499e-aed4-f7acb97b4a4b",
"db_language_id": "ae90b602-e529-4d8e-ac5d-ae8c0110f0c1",
"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-21T02:18:26.7035741+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7481d825-00f2-4348-a264-a4e2798c7457",
"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": "83e5ef57-838f-463e-bd5c-3f51676c169d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-21T02:18:26.7035741+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "47b4624a-4658-4291-a746-53e9a13e1915"
},
"suggested_date_start": "2026-06-21T02:18:26.7035741+00:00",
"skill_id": "f30765b1-f65a-4b42-988f-0297b2595f53",
"skill_code": "sample string 32",
"skill": {
"id": "99d73da2-b90e-46da-9792-c9b6f9e99dd8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b43b9ad6-3b45-4e87-9b7f-608692663130",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "01dba256-a90e-40ff-bf3c-1246df6bd32c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb9f6323-e51c-4ae7-bb26-c991996a841e",
"db_currency_id": "0610eeef-32b0-499e-aed4-f7acb97b4a4b",
"db_language_id": "ae90b602-e529-4d8e-ac5d-ae8c0110f0c1",
"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-21T02:18:26.7035741+00:00"
},
"modified_dateutc": "2026-06-21T02:18:26.7035741+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b9410b59-5540-45d5-8b26-6111517f09e2",
"date_reported_by_company": "2026-06-21T02:18:26.7035741+00:00",
"id2": 36,
"company_id": "277a783d-0f5c-4533-ba6b-94a1e4bcd7e4",
"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": "2ba366e3-02b8-4429-9eba-83c4b11477b0",
"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-21T02:18:26.7035741+00:00"
},
"work_instruction_details_id": "a24eeee9-c239-4674-b363-e90c1033714a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1807bb9d-61c4-4bbe-b5e8-dfce9c5c6317",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "44098436-e765-46ee-931a-5e1864ff8d85",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-21T02:18:26.7035741+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": "79dae54e-bd68-46a2-9103-58d9b3ac22e5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-21T02:18:26.7035741+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.