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": "e7feec1b-de0f-4687-9dd1-c9101ee83d23",
"jobs_id": "b24f3512-112d-44e0-a614-6e5e3ef2a67f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "973cedd7-625d-4208-a381-edc906ec31b4",
"_parent_id": "6aaeefa2-6bab-47d6-8f76-91bc925e278a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b56158e1-1ccd-4dee-8d43-5c0f2aad73ec",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4793805f-5c0f-4c0c-ae6f-fed12d093dbc",
"_parent_id": "729e99d5-e4d4-49c3-90c9-8fb127b9c069",
"root_parent_id": "d7654812-5d1a-4cb9-baef-6755013f07f6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9a4b30b2-bfb3-4bbc-b352-1125b804ceb3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ec6ed9f2-c238-405c-921a-5549e887cfef",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "57828b4b-042a-4610-af35-37e5ede684a6",
"_parent_code": "sample string 6",
"sales_organization_id": "11d825ab-97e4-4826-8ff3-b497840b9fda",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "37af7a8a-514b-46ea-a7b5-97ae7ee53f6c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41381eaf-9702-4d57-b9b8-148c3d730ea9",
"db_currency_id": "0ae95143-d56e-4c93-88c6-df394cee8fd3",
"db_language_id": "eb36056d-9255-48f4-ae05-732b56a73d23",
"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-01-04T11:18:17.3618645+00:00"
},
"modified_dateutc": "2026-01-04T11:18:17.3618645+00:00"
},
"equipment_model_id": "b2e45a35-1899-4af2-b74b-09c8a07edf77",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f4109e5d-b626-4c15-a9e7-12159cec3c7d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c206165e-6104-4052-8310-00957cac3536",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "29f806df-2bf1-42ce-9f9b-96f45de149f6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a6975e0a-91a8-42fc-8384-190615796e5f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "37af7a8a-514b-46ea-a7b5-97ae7ee53f6c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41381eaf-9702-4d57-b9b8-148c3d730ea9",
"db_currency_id": "0ae95143-d56e-4c93-88c6-df394cee8fd3",
"db_language_id": "eb36056d-9255-48f4-ae05-732b56a73d23",
"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-01-04T11:18:17.3618645+00:00"
},
"modified_dateutc": "2026-01-04T11:18:17.3618645+00:00"
},
"equipment_family_id": "9abf181d-4637-4f76-accf-4fca49c0cc40",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ec6ed9f2-c238-405c-921a-5549e887cfef",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "57828b4b-042a-4610-af35-37e5ede684a6",
"_parent_code": "sample string 6",
"sales_organization_id": "11d825ab-97e4-4826-8ff3-b497840b9fda",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "37af7a8a-514b-46ea-a7b5-97ae7ee53f6c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41381eaf-9702-4d57-b9b8-148c3d730ea9",
"db_currency_id": "0ae95143-d56e-4c93-88c6-df394cee8fd3",
"db_language_id": "eb36056d-9255-48f4-ae05-732b56a73d23",
"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-01-04T11:18:17.3618645+00:00"
},
"modified_dateutc": "2026-01-04T11:18:17.3618645+00:00"
},
"date_in_production_since": "2026-01-04T11:18:17.3618645+00:00",
"date_out_of_production_since": "2026-01-04T11:18:17.3618645+00:00",
"date_end_support": "2026-01-04T11:18:17.3618645+00:00",
"sales_organization_id": "ae97eca9-416d-49dd-91b8-9f009b1a0574",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "37af7a8a-514b-46ea-a7b5-97ae7ee53f6c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41381eaf-9702-4d57-b9b8-148c3d730ea9",
"db_currency_id": "0ae95143-d56e-4c93-88c6-df394cee8fd3",
"db_language_id": "eb36056d-9255-48f4-ae05-732b56a73d23",
"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-01-04T11:18:17.3618645+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-01-04T11:18:17.3618645+00:00"
},
"project_status_id": "86aac778-b5e5-4c36-a692-524d170308e0",
"project_status_code": "sample string 10",
"project_status": {
"id": "acb75d2c-6964-425c-a35b-98e337b8bec4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "73274188-749f-4e30-a8f8-a43b6e3da17c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "37af7a8a-514b-46ea-a7b5-97ae7ee53f6c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41381eaf-9702-4d57-b9b8-148c3d730ea9",
"db_currency_id": "0ae95143-d56e-4c93-88c6-df394cee8fd3",
"db_language_id": "eb36056d-9255-48f4-ae05-732b56a73d23",
"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-01-04T11:18:17.3618645+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-04T11:18:17.3618645+00:00"
},
"company_id": "407aa3dc-75ab-40ec-8e66-54f99bac504c",
"company_code": "sample string 12",
"db_address_id": "9d77087e-6cf0-4bd2-b967-53df280e5413",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ba4056d2-201c-40f2-83a3-aabe7304b391",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ad16060e-648b-4fd6-b65b-3299abbc9d4e",
"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-01-04T11:18:17.3618645+00:00",
"date_create": "2026-01-04T11:18:17.3618645+00:00",
"date_update": "2026-01-04T11:18:17.3618645+00:00",
"updated_by_user_id": "739eb11d-f1c4-47f2-86e1-20382f700b8b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-04T11:18:17.3618645+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-01-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-04T11:18:17.3618645+00:00",
"date_last_job": "2026-01-04T11:18:17.3618645+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-04T11:18:17.3618645+00:00",
"modified_dateutc": "2026-01-04T11:18:17.3618645+00:00",
"is_mobile_installation": true
},
"job_type_id": "78f198bb-45ba-44aa-9483-eef5ca99bc2a",
"job_type_code": "sample string 7",
"job_type": {
"id": "93bb14db-2aca-4f85-b4f3-005f298172fd",
"name": "sample string 2",
"sales_organization_id": "8ba04959-e8b7-49b8-af5d-f5838b7cf1bb",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-04T11:18:17.3618645+00:00",
"code": "sample string 7"
},
"job_priority_id": "5ec4c132-f20d-4dd5-ac2e-dc95c7da852b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d4a47444-c9f7-4bb8-82c4-0a4d2e8e821c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "142f4e8c-1168-4b81-b9af-df2204ee9044",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "37af7a8a-514b-46ea-a7b5-97ae7ee53f6c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41381eaf-9702-4d57-b9b8-148c3d730ea9",
"db_currency_id": "0ae95143-d56e-4c93-88c6-df394cee8fd3",
"db_language_id": "eb36056d-9255-48f4-ae05-732b56a73d23",
"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-01-04T11:18:17.3618645+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-04T11:18:17.3618645+00:00"
},
"job_status_id": "b39d3206-1180-4c35-9018-7e9adef5a222",
"job_status_code": "sample string 11",
"db_address_id": "ce09e338-e8ab-4720-b5ae-dd11be951c42",
"contact_id": "176bcbe2-d252-4a56-bd43-bbe092fc72d7",
"requested_by_company_id": "efadbfdf-82bc-4b30-9fca-b2762aa782bc",
"requested_by_contact_id": "5fb1151f-a12d-4bc4-ba30-b671a59553b9",
"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-01-04T11:18:17.3618645+00:00",
"due_date": "2026-01-04T11:18:17.3618645+00:00",
"date_create": "2026-01-04T11:18:17.3618645+00:00",
"date_update": "2026-01-04T11:18:17.3618645+00:00",
"date_closed": "2026-01-04T11:18:17.3618645+00:00",
"suggested_user_id": "1d06ed81-b5aa-4aed-b776-9c69b74d854f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "682a08cf-d0f4-4fb1-a4db-602681ae4380",
"db_language_id": "ed9692a4-d35e-4a38-866d-86d7f5e97c56",
"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-01-04T11:18:17.3618645+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "cad2ac5b-46e4-45ae-b534-0517e34c1e1d",
"sales_organization": {
"id": "37af7a8a-514b-46ea-a7b5-97ae7ee53f6c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41381eaf-9702-4d57-b9b8-148c3d730ea9",
"db_currency_id": "0ae95143-d56e-4c93-88c6-df394cee8fd3",
"db_language_id": "eb36056d-9255-48f4-ae05-732b56a73d23",
"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-01-04T11:18:17.3618645+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6fb1b297-4535-4a6f-8d5e-23eca41a02b3",
"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": "e6342d68-10aa-4f9b-b624-e912e3413002",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-04T11:18:17.3618645+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "66e4023c-039f-4671-99b4-b8406c4c52e3"
},
"suggested_date_start": "2026-01-04T11:18:17.3618645+00:00",
"skill_id": "aa48a1af-ad11-47ce-8e08-6b6ba5737890",
"skill_code": "sample string 32",
"skill": {
"id": "29bb9a11-4b5e-45f3-b26e-f3ff9b094aad",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7a57a49a-e1c7-448b-85ed-a042f393e6f1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "37af7a8a-514b-46ea-a7b5-97ae7ee53f6c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41381eaf-9702-4d57-b9b8-148c3d730ea9",
"db_currency_id": "0ae95143-d56e-4c93-88c6-df394cee8fd3",
"db_language_id": "eb36056d-9255-48f4-ae05-732b56a73d23",
"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-01-04T11:18:17.3618645+00:00"
},
"modified_dateutc": "2026-01-04T11:18:17.3618645+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6c686e6f-6409-49f7-9c3f-3fa91138a389",
"date_reported_by_company": "2026-01-04T11:18:17.3618645+00:00",
"id2": 36,
"company_id": "10489f5f-298e-4016-a1ef-641768c41f75",
"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": "1cb3fecb-eea1-4c0b-bcc7-ccb46cc5af7c",
"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-01-04T11:18:17.3618645+00:00"
},
"work_instruction_details_id": "dbc4aa96-3928-454a-b622-6405d49d07cd",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ae8f5cd1-9f42-4881-94b6-8edbfe43bf79",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c77add95-37da-4438-bce3-76b4f06368fe",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-04T11:18:17.3618645+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": "cef450ac-8a18-4648-8037-9fe3c0978843",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-04T11:18:17.3618645+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.