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": "1b9e6c8a-ec95-49fb-92a5-7d2bb81360ef",
"jobs_id": "bc449c97-ad7b-475b-8efa-7324008b93a1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f3cc8a67-e5d2-4c23-8692-fbce91e7b704",
"_parent_id": "4beee5fc-a276-4cf1-bea9-2a97ef87146b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7b57c836-0cbc-4c01-885e-6d891cc827ff",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6be97a59-a529-4bce-9856-e1f20f3323a2",
"_parent_id": "37061431-b3fd-48ef-858a-9310b5fe5efb",
"root_parent_id": "92b27012-82d8-4a88-aae6-82b02dc6f567",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "24c037e8-6fde-4396-a216-1bcd2821c0c5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1ea52f6c-3f86-440d-ac2a-d53cec38e5a0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9d221169-6954-49ee-aced-1c8b6312aa1c",
"_parent_code": "sample string 6",
"sales_organization_id": "facc2790-3b56-4cc1-8f09-20a885936e41",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "74eea536-5e59-4c74-a7c4-f73692860bde",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "350630f7-9a74-4bb0-99a6-cd92f2580510",
"db_currency_id": "8d46ff49-87b4-4fe6-9c50-d6c563d8acff",
"db_language_id": "7b050cd4-2614-4e57-8686-d99f715307d5",
"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-09-19T20:54:32.3798523+00:00"
},
"modified_dateutc": "2026-09-19T20:54:32.3798523+00:00"
},
"equipment_model_id": "904f2a42-8dfd-4271-a559-6de20442cf15",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fcca5ff8-c622-42ed-9809-ebfd8fb9195b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8b4ed6a0-74b4-4400-9aee-9a3ef6715cda",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a19c3d18-91c0-4c81-9d67-85a7f7da8f9f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8b98a379-6e57-472b-a021-87845b5c044a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "74eea536-5e59-4c74-a7c4-f73692860bde",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "350630f7-9a74-4bb0-99a6-cd92f2580510",
"db_currency_id": "8d46ff49-87b4-4fe6-9c50-d6c563d8acff",
"db_language_id": "7b050cd4-2614-4e57-8686-d99f715307d5",
"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-09-19T20:54:32.3798523+00:00"
},
"modified_dateutc": "2026-09-19T20:54:32.3798523+00:00"
},
"equipment_family_id": "65e12e80-e826-49e9-9db1-e659bd067122",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1ea52f6c-3f86-440d-ac2a-d53cec38e5a0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9d221169-6954-49ee-aced-1c8b6312aa1c",
"_parent_code": "sample string 6",
"sales_organization_id": "facc2790-3b56-4cc1-8f09-20a885936e41",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "74eea536-5e59-4c74-a7c4-f73692860bde",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "350630f7-9a74-4bb0-99a6-cd92f2580510",
"db_currency_id": "8d46ff49-87b4-4fe6-9c50-d6c563d8acff",
"db_language_id": "7b050cd4-2614-4e57-8686-d99f715307d5",
"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-09-19T20:54:32.3798523+00:00"
},
"modified_dateutc": "2026-09-19T20:54:32.3798523+00:00"
},
"date_in_production_since": "2026-09-19T20:54:32.3798523+00:00",
"date_out_of_production_since": "2026-09-19T20:54:32.3798523+00:00",
"date_end_support": "2026-09-19T20:54:32.3798523+00:00",
"sales_organization_id": "e2fb9aff-caa3-49ee-8c1d-e721ac7f395f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "74eea536-5e59-4c74-a7c4-f73692860bde",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "350630f7-9a74-4bb0-99a6-cd92f2580510",
"db_currency_id": "8d46ff49-87b4-4fe6-9c50-d6c563d8acff",
"db_language_id": "7b050cd4-2614-4e57-8686-d99f715307d5",
"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-09-19T20:54:32.3798523+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-09-19T20:54:32.3798523+00:00"
},
"project_status_id": "b2d02659-bdf6-47cb-a9d5-5c93848e98b5",
"project_status_code": "sample string 10",
"project_status": {
"id": "7fa625c6-1455-437b-a44a-0260ff240d55",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3cb221cd-77df-4f56-9350-e11a5d903e40",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74eea536-5e59-4c74-a7c4-f73692860bde",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "350630f7-9a74-4bb0-99a6-cd92f2580510",
"db_currency_id": "8d46ff49-87b4-4fe6-9c50-d6c563d8acff",
"db_language_id": "7b050cd4-2614-4e57-8686-d99f715307d5",
"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-09-19T20:54:32.3798523+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-19T20:54:32.3798523+00:00"
},
"company_id": "bf486f8a-533b-4fc2-81f9-77a661aa796d",
"company_code": "sample string 12",
"db_address_id": "947565a4-e362-4ef4-8cc7-a161bc758f6f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6331bc09-b0d6-4f4a-8c68-fc7b577928e9",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6971a26b-329f-41a5-a363-76a931295eb2",
"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-09-19T20:54:32.3798523+00:00",
"date_create": "2026-09-19T20:54:32.3798523+00:00",
"date_update": "2026-09-19T20:54:32.3798523+00:00",
"updated_by_user_id": "7799712e-123f-4729-bb2e-8373c4dc7ec8",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-19T20:54:32.3798523+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-09-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-19T20:54:32.3798523+00:00",
"date_last_job": "2026-09-19T20:54:32.3798523+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-19T20:54:32.3798523+00:00",
"modified_dateutc": "2026-09-19T20:54:32.3798523+00:00",
"is_mobile_installation": true
},
"job_type_id": "5140b638-ac8b-4e9f-ac4d-0bec2177c13e",
"job_type_code": "sample string 7",
"job_type": {
"id": "099c01d2-1120-41ae-af12-0d88a31e3d8e",
"name": "sample string 2",
"sales_organization_id": "de413f4d-d1ec-47ad-98ab-b058f4d0120a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-19T20:54:32.3798523+00:00",
"code": "sample string 7"
},
"job_priority_id": "e61acca4-afa1-4dc1-be23-b75d23c6cf73",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2b5aafb0-6c49-4b8f-9463-b85718a6571a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "af5716f5-ba7e-4bb4-8e29-caa5e15ea9ea",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74eea536-5e59-4c74-a7c4-f73692860bde",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "350630f7-9a74-4bb0-99a6-cd92f2580510",
"db_currency_id": "8d46ff49-87b4-4fe6-9c50-d6c563d8acff",
"db_language_id": "7b050cd4-2614-4e57-8686-d99f715307d5",
"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-09-19T20:54:32.3798523+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-19T20:54:32.3798523+00:00"
},
"job_status_id": "a1a55c0d-40f6-4222-8e6a-3a55a63a8104",
"job_status_code": "sample string 11",
"db_address_id": "4d4989bc-633c-4550-ab1e-b1a943025956",
"contact_id": "e21dbdec-a799-47ca-ac5c-82fe1b33cdea",
"requested_by_company_id": "a3b925fa-3a13-4adc-8b77-411301cc446a",
"requested_by_contact_id": "c03aad84-7b84-4a4e-94da-f3a1b02e7792",
"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-09-19T20:54:32.3798523+00:00",
"due_date": "2026-09-19T20:54:32.3798523+00:00",
"date_create": "2026-09-19T20:54:32.3798523+00:00",
"date_update": "2026-09-19T20:54:32.3798523+00:00",
"date_closed": "2026-09-19T20:54:32.3798523+00:00",
"suggested_user_id": "dad7bfd1-9dcb-4f40-80cf-b8f1e0b2b7c9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "75fe3ec9-99c2-497c-83d7-fed491fd5d70",
"db_language_id": "1cb5bcba-cbe3-4186-8611-0423c86e3e63",
"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-09-19T20:54:32.3798523+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5eb80dd2-dc2f-43f6-a1b0-dbb68392d192",
"sales_organization": {
"id": "74eea536-5e59-4c74-a7c4-f73692860bde",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "350630f7-9a74-4bb0-99a6-cd92f2580510",
"db_currency_id": "8d46ff49-87b4-4fe6-9c50-d6c563d8acff",
"db_language_id": "7b050cd4-2614-4e57-8686-d99f715307d5",
"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-09-19T20:54:32.3798523+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ba1b99ba-d264-4a38-b608-8c036ea3d505",
"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": "2fa4572b-3190-4748-a975-85ef2a2b9dab",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-19T20:54:32.3798523+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b79a715c-32b1-4835-a135-4b10a6c86710"
},
"suggested_date_start": "2026-09-19T20:54:32.3798523+00:00",
"skill_id": "d2f78716-7770-4ff9-9b6d-4e9e06d58f33",
"skill_code": "sample string 32",
"skill": {
"id": "c6be4830-f1d6-4e1b-9aab-84b639f26e0c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "297cb1d0-c969-49d3-b49e-b6e9c528564b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74eea536-5e59-4c74-a7c4-f73692860bde",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "350630f7-9a74-4bb0-99a6-cd92f2580510",
"db_currency_id": "8d46ff49-87b4-4fe6-9c50-d6c563d8acff",
"db_language_id": "7b050cd4-2614-4e57-8686-d99f715307d5",
"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-09-19T20:54:32.3798523+00:00"
},
"modified_dateutc": "2026-09-19T20:54:32.3798523+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b1639385-6081-4e52-a8c1-61836e1f2c7e",
"date_reported_by_company": "2026-09-19T20:54:32.3798523+00:00",
"id2": 36,
"company_id": "f6bea993-aa91-4062-b643-873544ed91af",
"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": "36e8c5c5-575b-4826-8f24-289c124581d8",
"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-09-19T20:54:32.3798523+00:00"
},
"work_instruction_details_id": "16cb40aa-d219-47c4-8ee7-3febef345930",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b4cbb321-184d-4942-bfe2-c349f0edb78d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9d086fe7-7139-4663-b82d-730d13116cef",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-19T20:54:32.3798523+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": "a6322fd2-7e27-4d83-98a4-6d7f3f08635c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-19T20:54:32.3798523+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.