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": "4b20a8f1-0efa-4bf2-ba91-ed06e2bb25ac",
"jobs_id": "b8a8cbf5-5ccb-4a9b-a6ff-587c62ae9887",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d9c47ba9-b7e5-4356-a2fa-4ec9ba48c389",
"_parent_id": "46ee0709-04eb-4e7c-9ec8-3013cf815d2a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "095d8dc1-b32c-4e28-af77-6aa9c2c3c364",
"project_reference_back_office": "sample string 5",
"project": {
"id": "379f90c0-0455-48c2-8499-313bebedf43c",
"_parent_id": "6a9fbba8-1763-453a-bca2-30b61f73db13",
"root_parent_id": "55294f55-d83d-4a19-9334-58d36cd0693f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "70969b1a-c684-4fcd-a6a8-c75bd24ed26b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1b8366cc-16c9-42ee-95a8-caceda5b6bf2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9c99dac9-cd58-4897-943e-b9d259ad8156",
"_parent_code": "sample string 6",
"sales_organization_id": "8c9a281a-8ed7-4032-afea-a3bc2fe2a7c2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "38e45cd3-0a7e-41f3-94a7-f3fffd16cc30",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8563a632-d352-4d3e-baf8-edd0d7be2236",
"db_currency_id": "ce2cb243-f4d5-429f-bcc6-227ec1a8bfe2",
"db_language_id": "5c248739-0ccb-4379-98dd-bd5ea0f19c45",
"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-01T12:26:29.8674344+00:00"
},
"modified_dateutc": "2026-09-01T12:26:29.8674344+00:00"
},
"equipment_model_id": "56a34c6c-f336-4962-9a4a-595e163652ef",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8e4e851e-3147-4771-89ec-3c67a51e29be",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8696b0ee-544b-46f9-8a91-cb3bf5d56fb2",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "360c94f7-d29a-4836-8681-0ec9d9d5e2d0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "84c386a5-2305-4809-a22f-4484a41b6b5c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "38e45cd3-0a7e-41f3-94a7-f3fffd16cc30",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8563a632-d352-4d3e-baf8-edd0d7be2236",
"db_currency_id": "ce2cb243-f4d5-429f-bcc6-227ec1a8bfe2",
"db_language_id": "5c248739-0ccb-4379-98dd-bd5ea0f19c45",
"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-01T12:26:29.8674344+00:00"
},
"modified_dateutc": "2026-09-01T12:26:29.8674344+00:00"
},
"equipment_family_id": "89fb4e05-2ace-4466-b245-56b7a6f59308",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1b8366cc-16c9-42ee-95a8-caceda5b6bf2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9c99dac9-cd58-4897-943e-b9d259ad8156",
"_parent_code": "sample string 6",
"sales_organization_id": "8c9a281a-8ed7-4032-afea-a3bc2fe2a7c2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "38e45cd3-0a7e-41f3-94a7-f3fffd16cc30",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8563a632-d352-4d3e-baf8-edd0d7be2236",
"db_currency_id": "ce2cb243-f4d5-429f-bcc6-227ec1a8bfe2",
"db_language_id": "5c248739-0ccb-4379-98dd-bd5ea0f19c45",
"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-01T12:26:29.8674344+00:00"
},
"modified_dateutc": "2026-09-01T12:26:29.8674344+00:00"
},
"date_in_production_since": "2026-09-01T12:26:29.8674344+00:00",
"date_out_of_production_since": "2026-09-01T12:26:29.8674344+00:00",
"date_end_support": "2026-09-01T12:26:29.8674344+00:00",
"sales_organization_id": "c8082c37-5dca-4095-b138-c75e9746a95c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "38e45cd3-0a7e-41f3-94a7-f3fffd16cc30",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8563a632-d352-4d3e-baf8-edd0d7be2236",
"db_currency_id": "ce2cb243-f4d5-429f-bcc6-227ec1a8bfe2",
"db_language_id": "5c248739-0ccb-4379-98dd-bd5ea0f19c45",
"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-01T12:26:29.8674344+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-01T12:26:29.8674344+00:00"
},
"project_status_id": "1b8eb58b-e9bc-4798-a10e-191d7aa0e2b6",
"project_status_code": "sample string 10",
"project_status": {
"id": "9bdb98c3-8391-4052-a67e-8dcd89e2bb3e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0deabbaf-eb67-49dd-a7ee-b049a9fdd5d7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "38e45cd3-0a7e-41f3-94a7-f3fffd16cc30",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8563a632-d352-4d3e-baf8-edd0d7be2236",
"db_currency_id": "ce2cb243-f4d5-429f-bcc6-227ec1a8bfe2",
"db_language_id": "5c248739-0ccb-4379-98dd-bd5ea0f19c45",
"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-01T12:26:29.8674344+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-01T12:26:29.8674344+00:00"
},
"company_id": "27f628dc-2d21-4861-a53e-d1ec7d254c16",
"company_code": "sample string 12",
"db_address_id": "e5c6b189-aa1c-4ea1-980e-2c80c7878715",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "173b526f-b4a3-4cac-a01a-886287caa6c8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6477dfbb-f23d-470f-a9dd-2ea98c26a143",
"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-01T12:26:29.8674344+00:00",
"date_create": "2026-09-01T12:26:29.8674344+00:00",
"date_update": "2026-09-01T12:26:29.8674344+00:00",
"updated_by_user_id": "3e721a68-e317-45ac-8c7a-bcdfde94e260",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-01T12:26:29.8674344+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-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-01T12:26:29.8674344+00:00",
"date_last_job": "2026-09-01T12:26:29.8674344+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-01T12:26:29.8674344+00:00",
"modified_dateutc": "2026-09-01T12:26:29.8674344+00:00",
"is_mobile_installation": true
},
"job_type_id": "2f0b92f4-b350-4030-b336-e03c404243ef",
"job_type_code": "sample string 7",
"job_type": {
"id": "e6479930-c356-4029-a1df-eb39bf22cbc3",
"name": "sample string 2",
"sales_organization_id": "99f23ca8-a45e-44c1-a3f1-a7a8d1a948c5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-01T12:26:29.8674344+00:00",
"code": "sample string 7"
},
"job_priority_id": "cedcac7a-3053-4233-afe7-ea82d644472e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "72309b9f-ba41-4ca8-a471-78bc91a4ae0e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a8e5ac4a-7739-492c-995f-c1a5b689e998",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "38e45cd3-0a7e-41f3-94a7-f3fffd16cc30",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8563a632-d352-4d3e-baf8-edd0d7be2236",
"db_currency_id": "ce2cb243-f4d5-429f-bcc6-227ec1a8bfe2",
"db_language_id": "5c248739-0ccb-4379-98dd-bd5ea0f19c45",
"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-01T12:26:29.8674344+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-01T12:26:29.8674344+00:00"
},
"job_status_id": "f8004d39-4087-4e8c-8310-51dff014ac3b",
"job_status_code": "sample string 11",
"db_address_id": "c5415d2b-00c8-47ff-a777-3ff85c7a870d",
"contact_id": "c1814e6a-7305-4dbd-b93b-c4c24ddb9c7e",
"requested_by_company_id": "7dafffc5-7405-4858-90d0-b4e5bcb9d883",
"requested_by_contact_id": "a4fea23d-d12c-469d-b0df-7995d7a8283e",
"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-01T12:26:29.8674344+00:00",
"due_date": "2026-09-01T12:26:29.8674344+00:00",
"date_create": "2026-09-01T12:26:29.8674344+00:00",
"date_update": "2026-09-01T12:26:29.8674344+00:00",
"date_closed": "2026-09-01T12:26:29.8674344+00:00",
"suggested_user_id": "d1ec7720-e7f4-4bec-b23e-8cbe0b5e2076",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "19a258d7-5b70-45a4-a5f0-2ba5928813b4",
"db_language_id": "3d5bb0b8-fdd1-43e2-aa9c-badef8944d2a",
"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-01T12:26:29.8674344+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "634d6e1d-3fff-4d72-b724-d9b690f8d4a5",
"sales_organization": {
"id": "38e45cd3-0a7e-41f3-94a7-f3fffd16cc30",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8563a632-d352-4d3e-baf8-edd0d7be2236",
"db_currency_id": "ce2cb243-f4d5-429f-bcc6-227ec1a8bfe2",
"db_language_id": "5c248739-0ccb-4379-98dd-bd5ea0f19c45",
"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-01T12:26:29.8674344+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8b8acf46-f837-4010-ab6d-e0726ee85acf",
"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": "81cd9672-dc08-49f8-9a14-5aa8765caaaa",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-01T12:26:29.8674344+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1f037301-8c7c-44de-8880-1434fc4c916e"
},
"suggested_date_start": "2026-09-01T12:26:29.8674344+00:00",
"skill_id": "9452b174-fd54-4374-b159-94dbccfb54d5",
"skill_code": "sample string 32",
"skill": {
"id": "baad6160-800e-4477-862e-d9c9a5ed3185",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "fad35bf5-0e50-4daa-b9c3-2685cd5eecfd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "38e45cd3-0a7e-41f3-94a7-f3fffd16cc30",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8563a632-d352-4d3e-baf8-edd0d7be2236",
"db_currency_id": "ce2cb243-f4d5-429f-bcc6-227ec1a8bfe2",
"db_language_id": "5c248739-0ccb-4379-98dd-bd5ea0f19c45",
"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-01T12:26:29.8674344+00:00"
},
"modified_dateutc": "2026-09-01T12:26:29.8674344+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "076dee43-c285-43e5-905f-70810345df3d",
"date_reported_by_company": "2026-09-01T12:26:29.8674344+00:00",
"id2": 36,
"company_id": "e18216cf-ec55-4a85-9597-bf62583e2534",
"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": "81121dc5-e039-48c3-a491-4cadb0421c9b",
"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-01T12:26:29.8674344+00:00"
},
"work_instruction_details_id": "eb77503f-5cd9-4913-9508-aa9c1a99ca51",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "644f5c30-a8af-4ff0-ac1f-f6b70220fc2a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "546ccecd-3318-4f3f-a41f-e3c398ab3a51",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-01T12:26:29.8674344+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": "3f85cf51-0c59-4b56-adc4-adc2b70feb37",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-01T12:26:29.8674344+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.