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": "3dba0505-9197-4e7d-801d-b9ff7b4d50d8",
"jobs_id": "db4c2c3b-4a1f-434e-8f04-d5ff3f3608b9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "bb6171c2-ea1a-4e08-a596-a504d86c7b60",
"_parent_id": "0b9cd02f-6cb6-435f-bf0d-1f8e12922082",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4313b859-0a87-49e6-9647-f3e2ccf18a06",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1d61e42c-58ee-4210-a51c-baeb33030f06",
"_parent_id": "08f1dd10-e14f-4a58-9751-31226d51c795",
"root_parent_id": "64d0e7db-19f1-442a-8700-1ad973389197",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "79fa134f-d90b-4491-bf52-ffd3c8a59cc7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e39471a6-221e-450a-bb39-e9850f363748",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "81012530-b310-4a0a-bc2f-0d7c6cafe050",
"_parent_code": "sample string 6",
"sales_organization_id": "64512289-880b-4691-a20a-1a317c69471e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a5e4628d-7db7-4173-89b9-ea6319b4aac0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa4bef2b-19f2-4cf0-8641-cc01b64654c5",
"db_currency_id": "d0d9758d-e992-4bc3-9bf1-5c6eb5f2c3b9",
"db_language_id": "88dc1bb9-b81b-41b9-b6d1-d2c9f1365dfd",
"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-04-07T19:36:25.6545279+00:00"
},
"modified_dateutc": "2026-04-07T19:36:25.6545279+00:00"
},
"equipment_model_id": "2398b461-5b68-4550-bcd7-e650249cd21f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "97930319-27fd-49d3-9afc-5df47899dfba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c4985abe-dbb2-445b-a9b3-0b0a98f802a0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "11f67ab1-ba78-4f9b-a046-27e8158f49b7",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d1c817ed-1f84-454e-aaba-3c5e47b0b86b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a5e4628d-7db7-4173-89b9-ea6319b4aac0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa4bef2b-19f2-4cf0-8641-cc01b64654c5",
"db_currency_id": "d0d9758d-e992-4bc3-9bf1-5c6eb5f2c3b9",
"db_language_id": "88dc1bb9-b81b-41b9-b6d1-d2c9f1365dfd",
"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-04-07T19:36:25.6545279+00:00"
},
"modified_dateutc": "2026-04-07T19:36:25.6545279+00:00"
},
"equipment_family_id": "52370cd7-9b6a-4296-b268-0cefec53e52d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e39471a6-221e-450a-bb39-e9850f363748",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "81012530-b310-4a0a-bc2f-0d7c6cafe050",
"_parent_code": "sample string 6",
"sales_organization_id": "64512289-880b-4691-a20a-1a317c69471e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a5e4628d-7db7-4173-89b9-ea6319b4aac0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa4bef2b-19f2-4cf0-8641-cc01b64654c5",
"db_currency_id": "d0d9758d-e992-4bc3-9bf1-5c6eb5f2c3b9",
"db_language_id": "88dc1bb9-b81b-41b9-b6d1-d2c9f1365dfd",
"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-04-07T19:36:25.6545279+00:00"
},
"modified_dateutc": "2026-04-07T19:36:25.6545279+00:00"
},
"date_in_production_since": "2026-04-07T19:36:25.6545279+00:00",
"date_out_of_production_since": "2026-04-07T19:36:25.6545279+00:00",
"date_end_support": "2026-04-07T19:36:25.6545279+00:00",
"sales_organization_id": "ec54af16-793c-45bc-b5c9-795693d9e4c6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a5e4628d-7db7-4173-89b9-ea6319b4aac0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa4bef2b-19f2-4cf0-8641-cc01b64654c5",
"db_currency_id": "d0d9758d-e992-4bc3-9bf1-5c6eb5f2c3b9",
"db_language_id": "88dc1bb9-b81b-41b9-b6d1-d2c9f1365dfd",
"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-04-07T19:36:25.6545279+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-04-07T19:36:25.6545279+00:00"
},
"project_status_id": "a7f4b3a3-c90a-413e-8551-2473e67eaae4",
"project_status_code": "sample string 10",
"project_status": {
"id": "1cafb438-9ffc-43f1-ae8d-7f1026e58e6d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "bdcb9ff2-c691-48e8-9812-f9efa81f5bb7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a5e4628d-7db7-4173-89b9-ea6319b4aac0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa4bef2b-19f2-4cf0-8641-cc01b64654c5",
"db_currency_id": "d0d9758d-e992-4bc3-9bf1-5c6eb5f2c3b9",
"db_language_id": "88dc1bb9-b81b-41b9-b6d1-d2c9f1365dfd",
"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-04-07T19:36:25.6545279+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-07T19:36:25.6545279+00:00"
},
"company_id": "0ed6cfbe-7082-4e38-a260-d482840ab10c",
"company_code": "sample string 12",
"db_address_id": "c895db28-b5ce-4143-8ab2-71afc1230dad",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "00a5224e-bc31-4ad1-bc78-f41ee695bd25",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6fae7a83-e531-458a-bf8c-115cc22d67ac",
"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-04-07T19:36:25.6545279+00:00",
"date_create": "2026-04-07T19:36:25.6545279+00:00",
"date_update": "2026-04-07T19:36:25.6545279+00:00",
"updated_by_user_id": "7074a35b-92dc-42fc-b039-523a4ae81cf5",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-07T19:36:25.6545279+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-04-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-07T19:36:25.6545279+00:00",
"date_last_job": "2026-04-07T19:36:25.6545279+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-07T19:36:25.6545279+00:00",
"modified_dateutc": "2026-04-07T19:36:25.6545279+00:00",
"is_mobile_installation": true
},
"job_type_id": "e9f738a7-f8f6-4aca-ad87-e1abfa36417b",
"job_type_code": "sample string 7",
"job_type": {
"id": "d567428d-70da-443d-9cce-4a9306634b17",
"name": "sample string 2",
"sales_organization_id": "ca75bf17-0e93-4191-96aa-8f3bf5f7723a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-07T19:36:25.6545279+00:00",
"code": "sample string 7"
},
"job_priority_id": "0acc5a43-1521-4f4f-95ff-e51dc1be8c02",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "21eb1d3e-fd3a-4a13-94df-b51fae9a5f55",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a6df18a6-4716-4b40-b888-54a57d93f7e3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a5e4628d-7db7-4173-89b9-ea6319b4aac0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa4bef2b-19f2-4cf0-8641-cc01b64654c5",
"db_currency_id": "d0d9758d-e992-4bc3-9bf1-5c6eb5f2c3b9",
"db_language_id": "88dc1bb9-b81b-41b9-b6d1-d2c9f1365dfd",
"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-04-07T19:36:25.6545279+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-07T19:36:25.6545279+00:00"
},
"job_status_id": "2a0adb84-fcb0-46ae-8836-723d895fb27b",
"job_status_code": "sample string 11",
"db_address_id": "24c8da9c-05b9-44af-9599-5e95b42ecfee",
"contact_id": "795912e8-3d78-4505-9992-dd2136aca190",
"requested_by_company_id": "6efe8714-a659-4072-af50-867d0b9f5fbd",
"requested_by_contact_id": "de629986-a22f-4f18-825d-34baefe8c1d2",
"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-04-07T19:36:25.6545279+00:00",
"due_date": "2026-04-07T19:36:25.6545279+00:00",
"date_create": "2026-04-07T19:36:25.6545279+00:00",
"date_update": "2026-04-07T19:36:25.6545279+00:00",
"date_closed": "2026-04-07T19:36:25.6545279+00:00",
"suggested_user_id": "85d1a6e0-1a14-48b9-a570-faf584f8c2ee",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2089baa4-484d-4b11-a52b-d20448ce2b24",
"db_language_id": "913dcbc4-66ea-4266-bd96-896aed78b52c",
"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-04-07T19:36:25.6545279+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d4e93f3a-e280-4475-86d2-e15487f1d09d",
"sales_organization": {
"id": "a5e4628d-7db7-4173-89b9-ea6319b4aac0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa4bef2b-19f2-4cf0-8641-cc01b64654c5",
"db_currency_id": "d0d9758d-e992-4bc3-9bf1-5c6eb5f2c3b9",
"db_language_id": "88dc1bb9-b81b-41b9-b6d1-d2c9f1365dfd",
"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-04-07T19:36:25.6545279+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "152d6c9c-d7c5-41d4-92c3-78b76dcf1bb2",
"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": "94177bf0-b4ad-4869-b997-20537d7a3aed",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-07T19:36:25.6701538+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b995789a-76a2-433f-9d75-dcfa904ea75d"
},
"suggested_date_start": "2026-04-07T19:36:25.6701538+00:00",
"skill_id": "df1ebecd-2418-4862-8d60-37805b3eb41b",
"skill_code": "sample string 32",
"skill": {
"id": "40440f84-c8a9-424d-86c8-f6e990991838",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "03404732-0445-475d-bb79-1e60bbfaff09",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a5e4628d-7db7-4173-89b9-ea6319b4aac0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa4bef2b-19f2-4cf0-8641-cc01b64654c5",
"db_currency_id": "d0d9758d-e992-4bc3-9bf1-5c6eb5f2c3b9",
"db_language_id": "88dc1bb9-b81b-41b9-b6d1-d2c9f1365dfd",
"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-04-07T19:36:25.6545279+00:00"
},
"modified_dateutc": "2026-04-07T19:36:25.6701538+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1177b906-b036-40d6-a354-967365018a25",
"date_reported_by_company": "2026-04-07T19:36:25.6701538+00:00",
"id2": 36,
"company_id": "a6c2365e-804d-4449-92e0-72711204264c",
"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": "a65ef35f-dba1-44f2-b062-ec39326874e9",
"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-04-07T19:36:25.6701538+00:00"
},
"work_instruction_details_id": "83bc2e03-b8d4-41e2-9601-3f26975448be",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "bd6daa69-9f4c-45dc-a656-d47fa7d1d1e9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3de9f21b-df21-44bc-9efd-67ff6ea7e39c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-07T19:36:25.6701538+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": "4cdceb18-5699-48d3-8499-3c24d7e950eb",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-07T19:36:25.6701538+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.