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": "8f82fbdb-31f0-43af-82df-fa0e86c1b8a4",
"jobs_id": "c7a87841-8049-40b4-9149-9c461c721e7e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "89a252fe-c5aa-4062-9480-cc85c44839da",
"_parent_id": "e4046c98-de34-47c9-adad-81748887f9a5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "58c47100-c57c-4afe-8319-a311d9584f1f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6da1e0c8-a911-4172-b630-22949c643ba0",
"_parent_id": "8446a895-fd4b-48bc-87a6-0137cdeafcb9",
"root_parent_id": "c9fdcad7-2a2f-4daf-bd9a-454f0ef48db4",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f37f125d-f039-4bc2-9041-274c75c461af",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f527e49f-5f5d-4b3d-bf18-35bbd9ee33f8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "514e3290-cf9c-41b6-9a55-9efc8b3b5c7c",
"_parent_code": "sample string 6",
"sales_organization_id": "981a0343-8a5e-45cb-8fd2-99ca0586bbe5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5c7f9437-5edd-4215-bebe-ca31f2756fec",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c61a57ad-6341-4c46-91af-ecf8455d1c5b",
"db_currency_id": "dbe660cb-ff2a-4b88-bd06-ac19fb2a8ef6",
"db_language_id": "3f43a74a-dfb8-4315-b4af-54a04a21f674",
"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-06-14T16:06:37.1490606+00:00"
},
"modified_dateutc": "2026-06-14T16:06:37.1490606+00:00"
},
"equipment_model_id": "bc8a6390-77f3-44ab-a6b3-6cd596241d0c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d154be71-2b66-44ad-842e-6f3bec3f5b04",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d85b7925-db9f-4eb5-858c-1c9f0657494d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5a6137ea-3713-430e-8e5b-c19a6a71a4c8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f4f1fce8-8d00-4775-9ac4-930668efe84f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5c7f9437-5edd-4215-bebe-ca31f2756fec",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c61a57ad-6341-4c46-91af-ecf8455d1c5b",
"db_currency_id": "dbe660cb-ff2a-4b88-bd06-ac19fb2a8ef6",
"db_language_id": "3f43a74a-dfb8-4315-b4af-54a04a21f674",
"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-06-14T16:06:37.1490606+00:00"
},
"modified_dateutc": "2026-06-14T16:06:37.1490606+00:00"
},
"equipment_family_id": "719d76d9-392c-4da9-96bb-699a179f1fc5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f527e49f-5f5d-4b3d-bf18-35bbd9ee33f8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "514e3290-cf9c-41b6-9a55-9efc8b3b5c7c",
"_parent_code": "sample string 6",
"sales_organization_id": "981a0343-8a5e-45cb-8fd2-99ca0586bbe5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5c7f9437-5edd-4215-bebe-ca31f2756fec",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c61a57ad-6341-4c46-91af-ecf8455d1c5b",
"db_currency_id": "dbe660cb-ff2a-4b88-bd06-ac19fb2a8ef6",
"db_language_id": "3f43a74a-dfb8-4315-b4af-54a04a21f674",
"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-06-14T16:06:37.1490606+00:00"
},
"modified_dateutc": "2026-06-14T16:06:37.1490606+00:00"
},
"date_in_production_since": "2026-06-14T16:06:37.1490606+00:00",
"date_out_of_production_since": "2026-06-14T16:06:37.1490606+00:00",
"date_end_support": "2026-06-14T16:06:37.1490606+00:00",
"sales_organization_id": "5b477bef-989f-45b1-ac86-dc0573c3c5f5",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5c7f9437-5edd-4215-bebe-ca31f2756fec",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c61a57ad-6341-4c46-91af-ecf8455d1c5b",
"db_currency_id": "dbe660cb-ff2a-4b88-bd06-ac19fb2a8ef6",
"db_language_id": "3f43a74a-dfb8-4315-b4af-54a04a21f674",
"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-06-14T16:06:37.1490606+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-06-14T16:06:37.1490606+00:00"
},
"project_status_id": "750cb690-c8a3-4e04-80de-c1692efeabc9",
"project_status_code": "sample string 10",
"project_status": {
"id": "636ffe27-b84c-4201-93f5-314b2ffdd6b3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e20ee812-344b-4803-aa46-dc5c9e657b3c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5c7f9437-5edd-4215-bebe-ca31f2756fec",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c61a57ad-6341-4c46-91af-ecf8455d1c5b",
"db_currency_id": "dbe660cb-ff2a-4b88-bd06-ac19fb2a8ef6",
"db_language_id": "3f43a74a-dfb8-4315-b4af-54a04a21f674",
"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-06-14T16:06:37.1490606+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-14T16:06:37.1490606+00:00"
},
"company_id": "55effec9-d509-487d-973c-41a380f4f09e",
"company_code": "sample string 12",
"db_address_id": "4f7f620d-8257-48b4-bd12-0b6fb2d3b6c0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d53cbee2-ffa8-42a4-aaba-82f0c7f20aae",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0bd8948a-7a02-4143-ae6a-63e6e0f06c2f",
"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-06-14T16:06:37.1490606+00:00",
"date_create": "2026-06-14T16:06:37.1490606+00:00",
"date_update": "2026-06-14T16:06:37.1490606+00:00",
"updated_by_user_id": "5a60a9c9-3be0-43a9-9b2c-404a3d31a91b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-14T16:06:37.1490606+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-06-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-14T16:06:37.1490606+00:00",
"date_last_job": "2026-06-14T16:06:37.1490606+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-14T16:06:37.1490606+00:00",
"modified_dateutc": "2026-06-14T16:06:37.1490606+00:00",
"is_mobile_installation": true
},
"job_type_id": "b27a0a69-090e-4e8e-85b8-e2775bd3a704",
"job_type_code": "sample string 7",
"job_type": {
"id": "02fb5bd0-889d-4dc8-b642-1c2293c216f5",
"name": "sample string 2",
"sales_organization_id": "0ff14daa-1da1-4b2b-9352-028cd4dd8d8e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-14T16:06:37.1490606+00:00",
"code": "sample string 7"
},
"job_priority_id": "b351a5d9-8226-48fa-9f78-4c28256ca841",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2a974f50-459e-4e81-8c7f-e8ebb308fee8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "123affd0-c498-4d57-bf27-528672617254",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5c7f9437-5edd-4215-bebe-ca31f2756fec",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c61a57ad-6341-4c46-91af-ecf8455d1c5b",
"db_currency_id": "dbe660cb-ff2a-4b88-bd06-ac19fb2a8ef6",
"db_language_id": "3f43a74a-dfb8-4315-b4af-54a04a21f674",
"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-06-14T16:06:37.1490606+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-14T16:06:37.1490606+00:00"
},
"job_status_id": "999bbb9d-1eff-4340-ba15-3bc28c58ef46",
"job_status_code": "sample string 11",
"db_address_id": "f48afb82-157c-4782-b3c8-d272261038a9",
"contact_id": "2024cbb4-62b0-44f9-aa97-86b93065b600",
"requested_by_company_id": "5a93c5a0-7512-4520-bd00-364a58e82b83",
"requested_by_contact_id": "d5f86187-6a41-4854-8c6a-fc1db53a80f9",
"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-06-14T16:06:37.1490606+00:00",
"due_date": "2026-06-14T16:06:37.1490606+00:00",
"date_create": "2026-06-14T16:06:37.1490606+00:00",
"date_update": "2026-06-14T16:06:37.1490606+00:00",
"date_closed": "2026-06-14T16:06:37.1490606+00:00",
"suggested_user_id": "8e112d64-70e5-4ef7-a529-a9c867d98395",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ece95f0d-5a85-4b1b-88a6-f4acbd83580d",
"db_language_id": "a73933d5-f6f7-4a08-b61b-5cb28407ba5a",
"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-06-14T16:06:37.1490606+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "494c341f-c210-4957-bd57-b8296d78f5b1",
"sales_organization": {
"id": "5c7f9437-5edd-4215-bebe-ca31f2756fec",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c61a57ad-6341-4c46-91af-ecf8455d1c5b",
"db_currency_id": "dbe660cb-ff2a-4b88-bd06-ac19fb2a8ef6",
"db_language_id": "3f43a74a-dfb8-4315-b4af-54a04a21f674",
"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-06-14T16:06:37.1490606+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "af2d3b2c-9cf4-4f18-91ac-d3654d630d8a",
"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": "7df29949-6620-490a-a0c6-30ce33aef45b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-14T16:06:37.1490606+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "84bb2e16-ca33-4826-9d84-c0d5168e7765"
},
"suggested_date_start": "2026-06-14T16:06:37.1490606+00:00",
"skill_id": "56167d79-024a-4e24-a18c-a39f83fc0b41",
"skill_code": "sample string 32",
"skill": {
"id": "aee967d3-1e84-4368-a4d0-c941d5300ee6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "cfc329f7-121e-4c83-8f60-4aa078812a75",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5c7f9437-5edd-4215-bebe-ca31f2756fec",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c61a57ad-6341-4c46-91af-ecf8455d1c5b",
"db_currency_id": "dbe660cb-ff2a-4b88-bd06-ac19fb2a8ef6",
"db_language_id": "3f43a74a-dfb8-4315-b4af-54a04a21f674",
"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-06-14T16:06:37.1490606+00:00"
},
"modified_dateutc": "2026-06-14T16:06:37.1490606+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4f4f44b6-29ee-4769-95de-ee3cbb9c3a2d",
"date_reported_by_company": "2026-06-14T16:06:37.1490606+00:00",
"id2": 36,
"company_id": "532c6972-4cd4-4f35-8219-721b86f3ace8",
"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": "e005bd54-eccd-4305-81fd-6276fa97d253",
"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-06-14T16:06:37.1490606+00:00"
},
"work_instruction_details_id": "daacaccb-8a99-4758-bcc6-86fbbad28fd6",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "69b32bab-9909-4437-9f2e-8e9530d8fe09",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cfa873ef-bd73-49e7-abeb-10f5b0d4bd6f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-14T16:06:37.1490606+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": "0684089c-ce9f-40b2-9df3-9f5df1fda87c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-14T16:06:37.1490606+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.