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": "f3cd4e01-d286-499a-b930-9e1f7b222a64",
"jobs_id": "07028a2c-6999-48a5-9b0f-5c94ef0bab73",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "588e76b0-8278-4394-93ba-bcc5e5a14bf8",
"_parent_id": "9d78d0c1-2211-4fb8-9553-95f74f4225f2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3b034cde-b676-41a6-8f57-acc8ec781cbb",
"project_reference_back_office": "sample string 5",
"project": {
"id": "36ad05fb-b88f-45f6-a8d2-1b520b52ebc4",
"_parent_id": "2641f5d9-11c3-4f44-8de6-f85354210eb2",
"root_parent_id": "f142e459-e7cc-4db3-917f-19314cbea88a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5e79afa7-152b-491c-a964-1a8efe6f2950",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5ddb0600-a4b1-46cf-97ba-d2651a5c42e2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f0e79d19-31bd-4c69-aa10-256cb2ea3d4a",
"_parent_code": "sample string 6",
"sales_organization_id": "21f36647-d0de-4267-bad9-307c94a3db08",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4b57c730-270f-4e13-b082-84a25f853d07",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4262f1c5-6bc0-4086-a63f-966b7f9df2b5",
"db_currency_id": "f16cc746-9143-470f-94c4-423c3cd47b7c",
"db_language_id": "6d8a562a-21d2-434c-881a-c7617f440fbc",
"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-02T05:54:12.5608142+00:00"
},
"modified_dateutc": "2026-02-02T05:54:12.5608142+00:00"
},
"equipment_model_id": "7350903f-ea52-4f66-94e8-7067d0159814",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b2829555-91fb-4feb-9846-6ff270bb04f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9048ce7d-f4f9-4380-9462-3d5f36411752",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7f257fe3-16a8-4d4f-b250-7089d05562c0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "09d6a492-ac99-42c4-a849-3c668893ade2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4b57c730-270f-4e13-b082-84a25f853d07",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4262f1c5-6bc0-4086-a63f-966b7f9df2b5",
"db_currency_id": "f16cc746-9143-470f-94c4-423c3cd47b7c",
"db_language_id": "6d8a562a-21d2-434c-881a-c7617f440fbc",
"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-02T05:54:12.5608142+00:00"
},
"modified_dateutc": "2026-02-02T05:54:12.5608142+00:00"
},
"equipment_family_id": "3af02b9b-ebdb-47c1-97eb-6c877b92ac68",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5ddb0600-a4b1-46cf-97ba-d2651a5c42e2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f0e79d19-31bd-4c69-aa10-256cb2ea3d4a",
"_parent_code": "sample string 6",
"sales_organization_id": "21f36647-d0de-4267-bad9-307c94a3db08",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4b57c730-270f-4e13-b082-84a25f853d07",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4262f1c5-6bc0-4086-a63f-966b7f9df2b5",
"db_currency_id": "f16cc746-9143-470f-94c4-423c3cd47b7c",
"db_language_id": "6d8a562a-21d2-434c-881a-c7617f440fbc",
"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-02T05:54:12.5608142+00:00"
},
"modified_dateutc": "2026-02-02T05:54:12.5608142+00:00"
},
"date_in_production_since": "2026-02-02T05:54:12.5608142+00:00",
"date_out_of_production_since": "2026-02-02T05:54:12.5608142+00:00",
"date_end_support": "2026-02-02T05:54:12.5608142+00:00",
"sales_organization_id": "6c370996-26fe-4919-9de4-3d7e7b683584",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4b57c730-270f-4e13-b082-84a25f853d07",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4262f1c5-6bc0-4086-a63f-966b7f9df2b5",
"db_currency_id": "f16cc746-9143-470f-94c4-423c3cd47b7c",
"db_language_id": "6d8a562a-21d2-434c-881a-c7617f440fbc",
"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-02T05:54:12.5608142+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-02T05:54:12.5608142+00:00"
},
"project_status_id": "a2b7ef34-3bb1-40d9-88ea-1be481b891ec",
"project_status_code": "sample string 10",
"project_status": {
"id": "4c2a7d88-e720-41da-bbc7-3d704caa09e5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b7b26df4-010a-43ad-906a-d97a7025d0f2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4b57c730-270f-4e13-b082-84a25f853d07",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4262f1c5-6bc0-4086-a63f-966b7f9df2b5",
"db_currency_id": "f16cc746-9143-470f-94c4-423c3cd47b7c",
"db_language_id": "6d8a562a-21d2-434c-881a-c7617f440fbc",
"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-02T05:54:12.5608142+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-02T05:54:12.5608142+00:00"
},
"company_id": "4c5c6a61-17c1-43fb-9fe1-cf43c3681aae",
"company_code": "sample string 12",
"db_address_id": "8edbf8fe-927f-4b9f-992e-64bb946178d1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7c39fb00-4aa4-4e3f-af10-53c3addaa443",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1fae1cfc-323f-42dc-b205-287b125cbc11",
"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-02T05:54:12.5608142+00:00",
"date_create": "2026-02-02T05:54:12.5608142+00:00",
"date_update": "2026-02-02T05:54:12.5608142+00:00",
"updated_by_user_id": "8fc99a5c-7392-4059-9ea3-4c38e7021257",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-02T05:54:12.5608142+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-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-02T05:54:12.5608142+00:00",
"date_last_job": "2026-02-02T05:54:12.5608142+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-02T05:54:12.5608142+00:00",
"modified_dateutc": "2026-02-02T05:54:12.5608142+00:00",
"is_mobile_installation": true
},
"job_type_id": "a3166be9-8ecc-4fa6-b3e7-14e39cbc2b4e",
"job_type_code": "sample string 7",
"job_type": {
"id": "cb4375e3-bd6a-4bb3-9068-b92653b01272",
"name": "sample string 2",
"sales_organization_id": "058922a2-0d38-4c1f-8313-124cda23dab0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-02T05:54:12.5608142+00:00",
"code": "sample string 7"
},
"job_priority_id": "a1ddb0a0-1440-4b18-9b60-9970c61566ec",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "057a4181-f779-46bd-9907-487bd42290e9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0deb10dc-a383-4204-bc6f-c9ec66744035",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4b57c730-270f-4e13-b082-84a25f853d07",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4262f1c5-6bc0-4086-a63f-966b7f9df2b5",
"db_currency_id": "f16cc746-9143-470f-94c4-423c3cd47b7c",
"db_language_id": "6d8a562a-21d2-434c-881a-c7617f440fbc",
"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-02T05:54:12.5608142+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-02T05:54:12.5608142+00:00"
},
"job_status_id": "ba40dc7f-a551-461d-a82c-9ee23c99a125",
"job_status_code": "sample string 11",
"db_address_id": "282720f6-6931-445a-93b5-8188b43730ca",
"contact_id": "f1b0d483-3fc5-48ec-ac42-bcb511b5f869",
"requested_by_company_id": "8cb99f60-c806-4b84-a055-2751d496542f",
"requested_by_contact_id": "e44123b4-ddfb-4d6a-9917-b7d1edf16d25",
"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-02T05:54:12.5608142+00:00",
"due_date": "2026-02-02T05:54:12.5608142+00:00",
"date_create": "2026-02-02T05:54:12.5608142+00:00",
"date_update": "2026-02-02T05:54:12.5608142+00:00",
"date_closed": "2026-02-02T05:54:12.5608142+00:00",
"suggested_user_id": "55608328-f5cf-4609-b58c-6735c0a79a38",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9cdd70a1-8a28-433e-9448-11436b821e52",
"db_language_id": "3296e390-a32d-4bc6-98a1-f2cd101e7059",
"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-02T05:54:12.5608142+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "aaf98cc2-a467-43dd-addb-04d7261366fa",
"sales_organization": {
"id": "4b57c730-270f-4e13-b082-84a25f853d07",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4262f1c5-6bc0-4086-a63f-966b7f9df2b5",
"db_currency_id": "f16cc746-9143-470f-94c4-423c3cd47b7c",
"db_language_id": "6d8a562a-21d2-434c-881a-c7617f440fbc",
"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-02T05:54:12.5608142+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "fd16bfd3-d75a-44ec-a75f-b0398dfad9ce",
"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": "955b9ac5-dc5e-4558-930a-f26b9e8ea5c7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-02T05:54:12.5608142+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f48ca46a-ae77-4e1c-8c96-2b6e7772d66e"
},
"suggested_date_start": "2026-02-02T05:54:12.5608142+00:00",
"skill_id": "c61a0d1e-f2da-4100-8689-e458498ecc0f",
"skill_code": "sample string 32",
"skill": {
"id": "9456a0a6-8801-4feb-a804-d7a4146ffa81",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c63d66fa-686d-468d-ad45-530da599fd2c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4b57c730-270f-4e13-b082-84a25f853d07",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4262f1c5-6bc0-4086-a63f-966b7f9df2b5",
"db_currency_id": "f16cc746-9143-470f-94c4-423c3cd47b7c",
"db_language_id": "6d8a562a-21d2-434c-881a-c7617f440fbc",
"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-02T05:54:12.5608142+00:00"
},
"modified_dateutc": "2026-02-02T05:54:12.5608142+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8a5f6c16-49d7-4ee6-b7e9-2a92ed4f8cc4",
"date_reported_by_company": "2026-02-02T05:54:12.5608142+00:00",
"id2": 36,
"company_id": "10c35066-660a-41e8-9ac7-8b4fa5806917",
"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": "65f443f6-aa40-4ca5-9e07-2b0fa78771fb",
"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-02T05:54:12.5608142+00:00"
},
"work_instruction_details_id": "1999ca72-e4aa-4c8f-b803-2126eb0767e5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ea6086cb-9467-4ec6-8545-13e68307bcee",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d272224e-e95f-4e1f-b9dd-130009a49fda",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-02T05:54:12.5608142+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": "6f6b1bf6-a75c-441f-ac48-efa8c318b722",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-02T05:54:12.5608142+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.