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": "8e37fe63-f71e-4da9-8254-e0d8666adcd6",
"jobs_id": "bd8b03a4-7cc8-4088-b361-afe9b6f0d7fa",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "fbbbbdd8-e3dd-43fb-baeb-f416bc166b73",
"_parent_id": "ead433e2-6b10-413f-acfb-1ad8fd6c1fca",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ad863df3-688a-48f0-b3a5-bb90e6798bb5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1968e3d6-45aa-4134-b9bc-9cd7f173006e",
"_parent_id": "d2a459b8-115d-4802-968d-4812d68bf29b",
"root_parent_id": "29d5b9a5-f6e3-4016-abc2-aacdf4f1f65d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a58f6a67-69c5-471f-b96f-164476691dd7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4e7028a9-0d94-45a6-b8a4-51ec010e0880",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "73eef342-7489-4bc6-9cad-a51c0692acaa",
"_parent_code": "sample string 6",
"sales_organization_id": "b209e351-8754-494d-a275-7114d8adb1ce",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c9c993e9-6e7c-4b19-8c5a-4950dbfd997b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c9a597c3-9c1a-47ea-b4b0-1dbfb1a5ee1a",
"db_currency_id": "ad6da032-a7aa-4bfb-b7a9-3c975cb145e5",
"db_language_id": "fae1ceca-3734-49bd-8944-32869153c4c8",
"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-30T08:24:43.2851135+00:00"
},
"modified_dateutc": "2026-09-30T08:24:43.2851135+00:00"
},
"equipment_model_id": "c13dbb87-648e-4473-a089-d4f68a01c2ab",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9e8ce000-b5f3-48a3-b29d-2ede6e4c6fe4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9676dda2-1867-4e32-bee7-6c67707c30c5",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "483bd40a-85b7-4004-b085-b56fd4d77f78",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "87064c06-a9de-41ab-9dc7-c310b28ca833",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c9c993e9-6e7c-4b19-8c5a-4950dbfd997b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c9a597c3-9c1a-47ea-b4b0-1dbfb1a5ee1a",
"db_currency_id": "ad6da032-a7aa-4bfb-b7a9-3c975cb145e5",
"db_language_id": "fae1ceca-3734-49bd-8944-32869153c4c8",
"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-30T08:24:43.2851135+00:00"
},
"modified_dateutc": "2026-09-30T08:24:43.2851135+00:00"
},
"equipment_family_id": "7497a121-a25b-4d89-992c-8eca9d3f5455",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4e7028a9-0d94-45a6-b8a4-51ec010e0880",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "73eef342-7489-4bc6-9cad-a51c0692acaa",
"_parent_code": "sample string 6",
"sales_organization_id": "b209e351-8754-494d-a275-7114d8adb1ce",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c9c993e9-6e7c-4b19-8c5a-4950dbfd997b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c9a597c3-9c1a-47ea-b4b0-1dbfb1a5ee1a",
"db_currency_id": "ad6da032-a7aa-4bfb-b7a9-3c975cb145e5",
"db_language_id": "fae1ceca-3734-49bd-8944-32869153c4c8",
"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-30T08:24:43.2851135+00:00"
},
"modified_dateutc": "2026-09-30T08:24:43.2851135+00:00"
},
"date_in_production_since": "2026-09-30T08:24:43.2851135+00:00",
"date_out_of_production_since": "2026-09-30T08:24:43.2851135+00:00",
"date_end_support": "2026-09-30T08:24:43.2851135+00:00",
"sales_organization_id": "e0c684f2-01b5-4cee-9675-32b44c900d42",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c9c993e9-6e7c-4b19-8c5a-4950dbfd997b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c9a597c3-9c1a-47ea-b4b0-1dbfb1a5ee1a",
"db_currency_id": "ad6da032-a7aa-4bfb-b7a9-3c975cb145e5",
"db_language_id": "fae1ceca-3734-49bd-8944-32869153c4c8",
"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-30T08:24:43.2851135+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-30T08:24:43.2958923+00:00"
},
"project_status_id": "5ff4353d-30da-4038-ba8a-2f05fe6f58a2",
"project_status_code": "sample string 10",
"project_status": {
"id": "581df803-b15b-425a-a3eb-242f88124e9f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "cd247e52-457a-4847-8515-03a50b75c423",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c9c993e9-6e7c-4b19-8c5a-4950dbfd997b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c9a597c3-9c1a-47ea-b4b0-1dbfb1a5ee1a",
"db_currency_id": "ad6da032-a7aa-4bfb-b7a9-3c975cb145e5",
"db_language_id": "fae1ceca-3734-49bd-8944-32869153c4c8",
"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-30T08:24:43.2851135+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-30T08:24:43.2958923+00:00"
},
"company_id": "5909d509-420e-4577-adcc-3360e88184e9",
"company_code": "sample string 12",
"db_address_id": "cd7afbd3-f653-4dc2-99c2-54403bc3721b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7058ce4e-3d39-4e2f-8349-00c729776963",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b2bb6ab4-ba1c-4e24-b09d-ac9a7a92863a",
"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-30T08:24:43.2958923+00:00",
"date_create": "2026-09-30T08:24:43.2958923+00:00",
"date_update": "2026-09-30T08:24:43.2958923+00:00",
"updated_by_user_id": "14b00dac-d105-41d6-9449-5dd1bbcf8ab0",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-30T08:24:43.2958923+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-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-30T08:24:43.2958923+00:00",
"date_last_job": "2026-09-30T08:24:43.2958923+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-30T08:24:43.2958923+00:00",
"modified_dateutc": "2026-09-30T08:24:43.2958923+00:00",
"is_mobile_installation": true
},
"job_type_id": "f7a90f0f-fd31-492f-ae81-ebd2a525f9fe",
"job_type_code": "sample string 7",
"job_type": {
"id": "61a08e30-06fd-440f-b61f-469abbb17753",
"name": "sample string 2",
"sales_organization_id": "a1c81f1b-cda8-4fe3-8fc9-9c4a55b1a45f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-30T08:24:43.2958923+00:00",
"code": "sample string 7"
},
"job_priority_id": "1ed83ed0-be90-415f-97e3-884934b90397",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5d568931-6bf3-464f-96b9-1012bdcb50a8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6a70d048-842d-4b90-a742-b9320edc51ad",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c9c993e9-6e7c-4b19-8c5a-4950dbfd997b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c9a597c3-9c1a-47ea-b4b0-1dbfb1a5ee1a",
"db_currency_id": "ad6da032-a7aa-4bfb-b7a9-3c975cb145e5",
"db_language_id": "fae1ceca-3734-49bd-8944-32869153c4c8",
"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-30T08:24:43.2851135+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-30T08:24:43.2958923+00:00"
},
"job_status_id": "0b369420-a2a4-41fe-924c-6ebea4b98ac2",
"job_status_code": "sample string 11",
"db_address_id": "4bf7f03f-67f1-4bbc-81fe-28bf96f32bdf",
"contact_id": "cd3b6a74-1848-499a-88ac-1455ca23917b",
"requested_by_company_id": "a4f18561-19e6-4313-a898-b68729405af9",
"requested_by_contact_id": "e9dc0274-4739-4017-90f5-ba159646f832",
"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-30T08:24:43.2958923+00:00",
"due_date": "2026-09-30T08:24:43.2958923+00:00",
"date_create": "2026-09-30T08:24:43.2958923+00:00",
"date_update": "2026-09-30T08:24:43.2958923+00:00",
"date_closed": "2026-09-30T08:24:43.2958923+00:00",
"suggested_user_id": "7cd3d0ca-0811-45ff-a45c-20678ed6173d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "152ecb65-97ba-4771-99b0-4aa3fa2ecc14",
"db_language_id": "c43d8b18-2679-4943-bd56-2802c26884f8",
"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-30T08:24:43.2958923+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ae0ee0ee-74b3-4065-aebe-cf49898e7d45",
"sales_organization": {
"id": "c9c993e9-6e7c-4b19-8c5a-4950dbfd997b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c9a597c3-9c1a-47ea-b4b0-1dbfb1a5ee1a",
"db_currency_id": "ad6da032-a7aa-4bfb-b7a9-3c975cb145e5",
"db_language_id": "fae1ceca-3734-49bd-8944-32869153c4c8",
"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-30T08:24:43.2851135+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "fff7ced0-9e35-44ba-a356-08d14f9e4af4",
"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": "4310c413-7fdd-4b30-833e-4384a4c61c81",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-30T08:24:43.2958923+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c5537a5d-2505-44b1-b009-a06d14e5cd7b"
},
"suggested_date_start": "2026-09-30T08:24:43.2958923+00:00",
"skill_id": "1d02276b-4aaf-4907-8bd8-a385cf1af334",
"skill_code": "sample string 32",
"skill": {
"id": "5e5c95c7-5fd6-4e3b-b195-09aa16f8022e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f98e3570-15a4-4d6d-8c2d-a6952300be88",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c9c993e9-6e7c-4b19-8c5a-4950dbfd997b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c9a597c3-9c1a-47ea-b4b0-1dbfb1a5ee1a",
"db_currency_id": "ad6da032-a7aa-4bfb-b7a9-3c975cb145e5",
"db_language_id": "fae1ceca-3734-49bd-8944-32869153c4c8",
"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-30T08:24:43.2851135+00:00"
},
"modified_dateutc": "2026-09-30T08:24:43.2958923+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "69611996-a7b7-452f-96d3-504e7f30ba3e",
"date_reported_by_company": "2026-09-30T08:24:43.2958923+00:00",
"id2": 36,
"company_id": "6a94b0df-e467-4f54-8a73-7099485751f5",
"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": "a8d91010-efe3-4cb3-ad6f-497340c8a1a3",
"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-30T08:24:43.2958923+00:00"
},
"work_instruction_details_id": "4ad1eba8-c0e6-48d3-b132-c7093707c9ee",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "038d0cee-04e4-4741-9f25-12e793a8f23b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "af688514-a7c4-430b-8948-b2dfd804b602",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-30T08:24:43.2958923+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": "3f78a895-82bc-45cb-b1aa-07529928c50b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-30T08:24:43.2958923+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.