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": "6722f966-8be1-4ad0-baa8-912626bfcbba",
"jobs_id": "cacf0e4f-9c73-4706-ab26-64fa47492512",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "513b92a1-5f7f-41e6-a6df-6af1073ab299",
"_parent_id": "d54d7918-698b-4257-b9aa-ff82ee46d3d2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "331131d1-e265-45cf-89e7-da993de5f5e9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "434030bd-50fb-4f0c-8c1d-0611d60d246e",
"_parent_id": "13111eaa-6176-4682-b89b-b3dff299a91c",
"root_parent_id": "8717af57-ab3c-4c09-bdfa-2415abf0947b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a2f4ebf9-bc43-4eb2-9e78-3d44ce4ce0a6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "765a3b47-9914-4085-8c84-be159b8fe02f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bb1aad20-d2c7-405f-b25d-603f9d43f6e4",
"_parent_code": "sample string 6",
"sales_organization_id": "e3de5e33-5927-4bec-9df8-6eca62b74362",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dbc863c9-0058-470d-968c-9fc809868e4a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "786f97e0-a6d1-4e8d-a875-5062f0794653",
"db_currency_id": "18c4411b-de28-4e92-98f1-34b204b75470",
"db_language_id": "c742265c-06e2-46a2-9e43-3c622bade6da",
"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-10-15T05:50:35.3433682+00:00"
},
"modified_dateutc": "2026-10-15T05:50:35.3433682+00:00"
},
"equipment_model_id": "02364bb2-154e-461d-a9eb-f7b84a2b4e7f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d7d5f658-9e20-4499-ab0d-3e2627e1c87d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a85d9a6e-bb19-4da1-a9cd-42538fe1450e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "df653eab-34c1-4383-9d22-dbbdccbf8b1b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "99f5c2e2-839c-439c-8c13-df747c2d96da",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dbc863c9-0058-470d-968c-9fc809868e4a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "786f97e0-a6d1-4e8d-a875-5062f0794653",
"db_currency_id": "18c4411b-de28-4e92-98f1-34b204b75470",
"db_language_id": "c742265c-06e2-46a2-9e43-3c622bade6da",
"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-10-15T05:50:35.3433682+00:00"
},
"modified_dateutc": "2026-10-15T05:50:35.3433682+00:00"
},
"equipment_family_id": "7235ce13-759e-4523-914f-2f0d404c89a4",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "765a3b47-9914-4085-8c84-be159b8fe02f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bb1aad20-d2c7-405f-b25d-603f9d43f6e4",
"_parent_code": "sample string 6",
"sales_organization_id": "e3de5e33-5927-4bec-9df8-6eca62b74362",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dbc863c9-0058-470d-968c-9fc809868e4a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "786f97e0-a6d1-4e8d-a875-5062f0794653",
"db_currency_id": "18c4411b-de28-4e92-98f1-34b204b75470",
"db_language_id": "c742265c-06e2-46a2-9e43-3c622bade6da",
"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-10-15T05:50:35.3433682+00:00"
},
"modified_dateutc": "2026-10-15T05:50:35.3433682+00:00"
},
"date_in_production_since": "2026-10-15T05:50:35.3433682+00:00",
"date_out_of_production_since": "2026-10-15T05:50:35.3433682+00:00",
"date_end_support": "2026-10-15T05:50:35.3433682+00:00",
"sales_organization_id": "285bd376-ea73-4e66-90ff-269e0851fd82",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "dbc863c9-0058-470d-968c-9fc809868e4a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "786f97e0-a6d1-4e8d-a875-5062f0794653",
"db_currency_id": "18c4411b-de28-4e92-98f1-34b204b75470",
"db_language_id": "c742265c-06e2-46a2-9e43-3c622bade6da",
"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-10-15T05:50:35.3433682+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-10-15T05:50:35.3433682+00:00"
},
"project_status_id": "9f72bb7d-0266-4a30-9db6-e445f3b3ff7d",
"project_status_code": "sample string 10",
"project_status": {
"id": "186e51c9-66b7-4fad-99e1-530bdde529da",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d75e0422-74be-4d6d-86e0-023d81e6a872",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dbc863c9-0058-470d-968c-9fc809868e4a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "786f97e0-a6d1-4e8d-a875-5062f0794653",
"db_currency_id": "18c4411b-de28-4e92-98f1-34b204b75470",
"db_language_id": "c742265c-06e2-46a2-9e43-3c622bade6da",
"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-10-15T05:50:35.3433682+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-15T05:50:35.3433682+00:00"
},
"company_id": "3aa8318a-1fdc-4d2f-93d9-15916c953ffb",
"company_code": "sample string 12",
"db_address_id": "564a1683-f3df-478a-bacb-7cb1f7f79ff0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7d48a86a-1659-45b2-b668-21ef491b6e61",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3abaa430-d125-40e6-9c96-f285f815d8d2",
"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-10-15T05:50:35.3632157+00:00",
"date_create": "2026-10-15T05:50:35.3632157+00:00",
"date_update": "2026-10-15T05:50:35.3632157+00:00",
"updated_by_user_id": "598f273b-353b-41e4-9b18-64ef0905842a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-15T05:50:35.3632157+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-10-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-15T05:50:35.3632157+00:00",
"date_last_job": "2026-10-15T05:50:35.3632157+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-15T05:50:35.3632157+00:00",
"modified_dateutc": "2026-10-15T05:50:35.3632157+00:00",
"is_mobile_installation": true
},
"job_type_id": "bd31cbcb-7907-4f02-a8f9-24ae24a36f9e",
"job_type_code": "sample string 7",
"job_type": {
"id": "55f88ecc-032f-428f-b895-7ce07c0c5120",
"name": "sample string 2",
"sales_organization_id": "9b7fca32-e741-4b87-8452-b1a92ad2a365",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-15T05:50:35.3632157+00:00",
"code": "sample string 7"
},
"job_priority_id": "c56e5f8f-9d71-4208-8593-fdfb6fb9506e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2329ff10-f8ca-4a64-8679-62cdcc841a61",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a1c4ac7c-0f32-4572-8d47-99a0311fb1f8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dbc863c9-0058-470d-968c-9fc809868e4a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "786f97e0-a6d1-4e8d-a875-5062f0794653",
"db_currency_id": "18c4411b-de28-4e92-98f1-34b204b75470",
"db_language_id": "c742265c-06e2-46a2-9e43-3c622bade6da",
"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-10-15T05:50:35.3433682+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-15T05:50:35.3632157+00:00"
},
"job_status_id": "3aadc9cf-3e07-4fb8-8de0-73e213222b31",
"job_status_code": "sample string 11",
"db_address_id": "08fb743d-3515-4df7-9e2a-3822d60127fc",
"contact_id": "6761190f-c953-4293-a24e-08f54c2b4924",
"requested_by_company_id": "317df818-fa0d-4a48-b22c-58a16333b533",
"requested_by_contact_id": "a91bcc86-66e7-4245-9dff-c8720da535ad",
"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-10-15T05:50:35.3632157+00:00",
"due_date": "2026-10-15T05:50:35.3632157+00:00",
"date_create": "2026-10-15T05:50:35.3632157+00:00",
"date_update": "2026-10-15T05:50:35.3632157+00:00",
"date_closed": "2026-10-15T05:50:35.3632157+00:00",
"suggested_user_id": "da7d6cf0-a09e-4492-9c32-0ec679c0c73e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2afaef53-5772-4983-a870-f60f91c61b44",
"db_language_id": "ee08d2b7-2555-489d-973e-a76f9be80a23",
"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-10-15T05:50:35.3632157+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5fccf17d-4469-4a37-afa6-25ba021467dd",
"sales_organization": {
"id": "dbc863c9-0058-470d-968c-9fc809868e4a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "786f97e0-a6d1-4e8d-a875-5062f0794653",
"db_currency_id": "18c4411b-de28-4e92-98f1-34b204b75470",
"db_language_id": "c742265c-06e2-46a2-9e43-3c622bade6da",
"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-10-15T05:50:35.3433682+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "350d9779-2d7b-4bb2-89cc-e6ca46e4707e",
"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": "9d631388-fd90-44cf-9099-db04981956d2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-15T05:50:35.3632157+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4b1a054d-e884-40d4-be9e-37ce1bd0fe85"
},
"suggested_date_start": "2026-10-15T05:50:35.3632157+00:00",
"skill_id": "785f1155-97b5-42b8-8b35-37e3277d8f2c",
"skill_code": "sample string 32",
"skill": {
"id": "b3e86120-5089-4a33-94b6-dde2944fc258",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1731038a-6086-4601-8d4a-38a09ceb3c2c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dbc863c9-0058-470d-968c-9fc809868e4a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "786f97e0-a6d1-4e8d-a875-5062f0794653",
"db_currency_id": "18c4411b-de28-4e92-98f1-34b204b75470",
"db_language_id": "c742265c-06e2-46a2-9e43-3c622bade6da",
"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-10-15T05:50:35.3433682+00:00"
},
"modified_dateutc": "2026-10-15T05:50:35.3745537+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fd53db37-9f1b-4bc7-9bc1-bb7e057f4b75",
"date_reported_by_company": "2026-10-15T05:50:35.3745537+00:00",
"id2": 36,
"company_id": "e9870672-178c-45ac-a850-335bfb4e1b57",
"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": "8c873f4a-94c2-41a7-82af-a182d4cd5697",
"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-10-15T05:50:35.3745537+00:00"
},
"work_instruction_details_id": "90ec2ad8-9822-42c7-8cc3-ac2e66625d04",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4055a329-6d56-4cce-b7c4-788a41f95cfd",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "df16cd9f-110a-4715-96e4-163262fb1bc4",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-15T05:50:35.3745537+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": "e2910de9-098c-4cf2-a3ee-386d0ea20136",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-15T05:50:35.3745537+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.