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": "d6efe762-262d-4574-aa25-2472b0d82bed",
"jobs_id": "35b352fb-1939-4427-a315-97582179d783",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "17075c36-6bad-41be-befc-0044f2dc59bc",
"_parent_id": "03055721-dfba-4ecc-9189-2fe4a506180a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7d2bf0ab-d360-4c8b-9b84-81a833b23e27",
"project_reference_back_office": "sample string 5",
"project": {
"id": "401b59be-bd4f-4ad9-81ce-5cf279d67a58",
"_parent_id": "3ea6c977-add4-4576-85d2-0290fe8607d3",
"root_parent_id": "f4f24359-529a-46dd-8ef5-ffa3667acecb",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "57d2a867-0d08-47c2-8ee1-b488a5dfdfe4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b817b9e1-99cb-45a4-9b1c-99c64a63758d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f41a4827-b409-4cdf-9db5-3308396e9927",
"_parent_code": "sample string 6",
"sales_organization_id": "d09e1c86-5d92-4497-a375-6450181c92be",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ed9e2edf-97ff-48d3-9f45-09e015546515",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d32d50ad-9f8e-4c72-bc89-914edf1c4f49",
"db_currency_id": "3a74c4ac-0763-495f-9852-843baf938f88",
"db_language_id": "95c5969b-34bd-48ce-a435-6b3689795fe5",
"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-04-27T10:52:02.8826719+00:00"
},
"modified_dateutc": "2026-04-27T10:52:02.8826719+00:00"
},
"equipment_model_id": "7722bf0b-ba01-4ca4-901a-e80ef6d7ea59",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "04151643-4ca8-46bb-885a-8d20980629df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "19730673-3793-4617-b803-f499bb0e8b5d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1ee4b111-da2a-4c40-96c1-229b5ec6ef83",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "daee02d5-00d1-45b4-ac79-e1414f4e439d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ed9e2edf-97ff-48d3-9f45-09e015546515",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d32d50ad-9f8e-4c72-bc89-914edf1c4f49",
"db_currency_id": "3a74c4ac-0763-495f-9852-843baf938f88",
"db_language_id": "95c5969b-34bd-48ce-a435-6b3689795fe5",
"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-04-27T10:52:02.8826719+00:00"
},
"modified_dateutc": "2026-04-27T10:52:02.8826719+00:00"
},
"equipment_family_id": "d3170f2c-1ead-46e1-96af-a5a726ef42d2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b817b9e1-99cb-45a4-9b1c-99c64a63758d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f41a4827-b409-4cdf-9db5-3308396e9927",
"_parent_code": "sample string 6",
"sales_organization_id": "d09e1c86-5d92-4497-a375-6450181c92be",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ed9e2edf-97ff-48d3-9f45-09e015546515",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d32d50ad-9f8e-4c72-bc89-914edf1c4f49",
"db_currency_id": "3a74c4ac-0763-495f-9852-843baf938f88",
"db_language_id": "95c5969b-34bd-48ce-a435-6b3689795fe5",
"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-04-27T10:52:02.8826719+00:00"
},
"modified_dateutc": "2026-04-27T10:52:02.8826719+00:00"
},
"date_in_production_since": "2026-04-27T10:52:02.8826719+00:00",
"date_out_of_production_since": "2026-04-27T10:52:02.8826719+00:00",
"date_end_support": "2026-04-27T10:52:02.8826719+00:00",
"sales_organization_id": "fa5d1374-9aa5-4f71-8d39-725f0a9d5390",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ed9e2edf-97ff-48d3-9f45-09e015546515",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d32d50ad-9f8e-4c72-bc89-914edf1c4f49",
"db_currency_id": "3a74c4ac-0763-495f-9852-843baf938f88",
"db_language_id": "95c5969b-34bd-48ce-a435-6b3689795fe5",
"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-04-27T10:52:02.8826719+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-04-27T10:52:02.8826719+00:00"
},
"project_status_id": "89148b5f-3749-46cb-b79b-159b74865ade",
"project_status_code": "sample string 10",
"project_status": {
"id": "d50366c0-e5ce-48c7-b404-7e861e63663d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "35f3a416-4390-4d8b-9738-ceb21e369051",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ed9e2edf-97ff-48d3-9f45-09e015546515",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d32d50ad-9f8e-4c72-bc89-914edf1c4f49",
"db_currency_id": "3a74c4ac-0763-495f-9852-843baf938f88",
"db_language_id": "95c5969b-34bd-48ce-a435-6b3689795fe5",
"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-04-27T10:52:02.8826719+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-27T10:52:02.8982923+00:00"
},
"company_id": "9a679b71-a590-4b0a-b106-dfb6a0bd20ae",
"company_code": "sample string 12",
"db_address_id": "ee3b9e25-9d6b-4bbe-b2e0-b984fb3a65df",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e80c17ba-cb66-4bc3-b858-82dea2e38f20",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8e8927bb-d8a1-4025-83ec-7ec81061d224",
"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-04-27T10:52:02.8982923+00:00",
"date_create": "2026-04-27T10:52:02.8982923+00:00",
"date_update": "2026-04-27T10:52:02.8982923+00:00",
"updated_by_user_id": "82f1a6ac-600d-4dd2-91f7-d42c332495c9",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-27T10:52:02.8982923+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-04-27T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-27T10:52:02.8982923+00:00",
"date_last_job": "2026-04-27T10:52:02.8982923+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-27T10:52:02.8982923+00:00",
"modified_dateutc": "2026-04-27T10:52:02.8982923+00:00",
"is_mobile_installation": true
},
"job_type_id": "c36939c5-3a7f-4fb8-aee9-545bd2503d35",
"job_type_code": "sample string 7",
"job_type": {
"id": "0ce5f8fd-7e26-4ad1-8918-07b0fd1accf9",
"name": "sample string 2",
"sales_organization_id": "f00f9a50-6249-432b-8441-0edea8a9e113",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-27T10:52:02.8982923+00:00",
"code": "sample string 7"
},
"job_priority_id": "cc88a746-477b-48a8-813b-289803360ed0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1173cf56-8aeb-4ac4-bf1d-f9dd90a75546",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b0f23b22-25e7-40e3-842d-1287d7bd29db",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ed9e2edf-97ff-48d3-9f45-09e015546515",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d32d50ad-9f8e-4c72-bc89-914edf1c4f49",
"db_currency_id": "3a74c4ac-0763-495f-9852-843baf938f88",
"db_language_id": "95c5969b-34bd-48ce-a435-6b3689795fe5",
"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-04-27T10:52:02.8826719+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-27T10:52:02.8982923+00:00"
},
"job_status_id": "e7764c5d-3e26-446e-983f-a80b4ff8ad16",
"job_status_code": "sample string 11",
"db_address_id": "6996cf61-203a-4a7b-8f10-8f4a9cbb42da",
"contact_id": "8034f454-db07-4f58-80ba-31dfebb8268f",
"requested_by_company_id": "89086803-aec3-4e67-b99f-4219284fab8c",
"requested_by_contact_id": "2792c795-562d-4a77-a9f8-c31d33bb8a55",
"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-04-27T10:52:02.8982923+00:00",
"due_date": "2026-04-27T10:52:02.8982923+00:00",
"date_create": "2026-04-27T10:52:02.8982923+00:00",
"date_update": "2026-04-27T10:52:02.8982923+00:00",
"date_closed": "2026-04-27T10:52:02.8982923+00:00",
"suggested_user_id": "dc468f86-1c38-4985-b17d-c908277a42bc",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d84009f8-c58c-44fb-ad70-5666e2be1852",
"db_language_id": "ec98e5fe-3920-4a98-bad7-50510e5dd383",
"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-04-27T10:52:02.8982923+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "571a4b61-e2c1-4aee-8c28-5790c9ae7057",
"sales_organization": {
"id": "ed9e2edf-97ff-48d3-9f45-09e015546515",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d32d50ad-9f8e-4c72-bc89-914edf1c4f49",
"db_currency_id": "3a74c4ac-0763-495f-9852-843baf938f88",
"db_language_id": "95c5969b-34bd-48ce-a435-6b3689795fe5",
"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-04-27T10:52:02.8826719+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ed378f2c-7642-45f4-8e39-11385e2a9610",
"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": "c45693bd-5ec8-4dc1-be3a-415c22f3e909",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-27T10:52:02.8982923+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b1d55317-5119-439c-b60e-61bab2bee480"
},
"suggested_date_start": "2026-04-27T10:52:02.8982923+00:00",
"skill_id": "2b3bac89-36af-4001-a80f-985ea115b00b",
"skill_code": "sample string 32",
"skill": {
"id": "d4b5e4d9-315a-4ac1-93da-5075caa45ee5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5bafa4f5-abc1-447e-a8a8-18b6cae3f5be",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ed9e2edf-97ff-48d3-9f45-09e015546515",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d32d50ad-9f8e-4c72-bc89-914edf1c4f49",
"db_currency_id": "3a74c4ac-0763-495f-9852-843baf938f88",
"db_language_id": "95c5969b-34bd-48ce-a435-6b3689795fe5",
"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-04-27T10:52:02.8826719+00:00"
},
"modified_dateutc": "2026-04-27T10:52:02.8982923+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d8f1a8e9-8ab4-4553-b00a-4949cd09f797",
"date_reported_by_company": "2026-04-27T10:52:02.8982923+00:00",
"id2": 36,
"company_id": "f4295d5c-6a7b-493a-808e-8f8719a6eba1",
"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": "304cd972-674e-4d44-8af0-63e43e436ea0",
"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-04-27T10:52:02.8982923+00:00"
},
"work_instruction_details_id": "75c275ec-5ff7-4ba4-861b-02f1272fbdcb",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "db1c4923-7f0b-4508-912a-043f35a6340a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5d306c6f-daa8-4121-a1c0-859195667320",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-27T10:52:02.8982923+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": "b3e8e4c6-51eb-42f2-8254-f9ebbf813325",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-27T10:52:02.8982923+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.