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": "a1f76084-10af-4bc0-8f41-7738b0c4b11d",
"jobs_id": "d98e3337-830d-411a-b784-05d4f8f4fd1b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1011680f-6426-4e0e-a418-364e0392b546",
"_parent_id": "f3d2499b-5751-458b-9ddf-4827e031d0b5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "112c789f-5040-4ff6-9b20-5539e53beb9b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "08198c4d-5d16-4eb8-b390-7868a6551ff3",
"_parent_id": "16110456-10a3-45cf-88c2-a2960860f0b5",
"root_parent_id": "3e9c2d71-8ae2-4739-9998-804087f29352",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d0e671b6-f5fe-40d1-b458-9599b65518e0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "08a47130-da44-4685-9e26-89b03049a7a7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7d9cf479-39a6-440e-929f-991fe7443003",
"_parent_code": "sample string 6",
"sales_organization_id": "850e5a20-49d6-4687-b958-55f331c12eeb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "32921a53-f6cb-4eef-9db4-5e440453ce98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1de4c84-a04b-4880-8cb6-91e88992adef",
"db_currency_id": "8495fab1-2971-493b-b8b3-e3c0d7a2ef83",
"db_language_id": "2e899658-ff2c-4605-8603-d2b8f755eaf1",
"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-04T06:48:50.2965509+00:00"
},
"modified_dateutc": "2026-09-04T06:48:50.2965509+00:00"
},
"equipment_model_id": "122f908f-4d94-4921-8610-48c141e3d3ec",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d8985e44-2b10-4652-b615-0e16bbbcf44a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "745cf28c-a578-47b2-97c6-afe3756375c8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "536a0a56-0a14-4394-a1df-4216662fd582",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f28a75b3-fad4-4288-a2d1-245353931574",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "32921a53-f6cb-4eef-9db4-5e440453ce98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1de4c84-a04b-4880-8cb6-91e88992adef",
"db_currency_id": "8495fab1-2971-493b-b8b3-e3c0d7a2ef83",
"db_language_id": "2e899658-ff2c-4605-8603-d2b8f755eaf1",
"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-04T06:48:50.2965509+00:00"
},
"modified_dateutc": "2026-09-04T06:48:50.2965509+00:00"
},
"equipment_family_id": "63169946-8b87-4016-b480-2f1b0878db6d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "08a47130-da44-4685-9e26-89b03049a7a7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7d9cf479-39a6-440e-929f-991fe7443003",
"_parent_code": "sample string 6",
"sales_organization_id": "850e5a20-49d6-4687-b958-55f331c12eeb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "32921a53-f6cb-4eef-9db4-5e440453ce98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1de4c84-a04b-4880-8cb6-91e88992adef",
"db_currency_id": "8495fab1-2971-493b-b8b3-e3c0d7a2ef83",
"db_language_id": "2e899658-ff2c-4605-8603-d2b8f755eaf1",
"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-04T06:48:50.2965509+00:00"
},
"modified_dateutc": "2026-09-04T06:48:50.2965509+00:00"
},
"date_in_production_since": "2026-09-04T06:48:50.2965509+00:00",
"date_out_of_production_since": "2026-09-04T06:48:50.2965509+00:00",
"date_end_support": "2026-09-04T06:48:50.2965509+00:00",
"sales_organization_id": "5310cbac-9f2f-4a10-aa3a-eab67a01436b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "32921a53-f6cb-4eef-9db4-5e440453ce98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1de4c84-a04b-4880-8cb6-91e88992adef",
"db_currency_id": "8495fab1-2971-493b-b8b3-e3c0d7a2ef83",
"db_language_id": "2e899658-ff2c-4605-8603-d2b8f755eaf1",
"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-04T06:48:50.2965509+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-04T06:48:50.2965509+00:00"
},
"project_status_id": "8df03fdc-e4eb-4cb0-91fb-97165d618298",
"project_status_code": "sample string 10",
"project_status": {
"id": "54037257-472c-4081-8e1e-e070abd277eb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a2d7ae09-5810-4a34-832b-5ea346ac427b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "32921a53-f6cb-4eef-9db4-5e440453ce98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1de4c84-a04b-4880-8cb6-91e88992adef",
"db_currency_id": "8495fab1-2971-493b-b8b3-e3c0d7a2ef83",
"db_language_id": "2e899658-ff2c-4605-8603-d2b8f755eaf1",
"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-04T06:48:50.2965509+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-04T06:48:50.2965509+00:00"
},
"company_id": "74bdf016-06f9-41bb-809e-a48ec203dcbe",
"company_code": "sample string 12",
"db_address_id": "351104bb-3612-4efb-aaf3-00be9c80d342",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "edd0066a-8405-497d-8241-a202e6b9aa18",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d88527b7-fdf5-4b02-a0d5-298df381d679",
"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-04T06:48:50.2965509+00:00",
"date_create": "2026-09-04T06:48:50.2965509+00:00",
"date_update": "2026-09-04T06:48:50.2965509+00:00",
"updated_by_user_id": "60cc210d-74e4-4397-b77b-e132ff17de0b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-04T06:48:50.2965509+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-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-04T06:48:50.2965509+00:00",
"date_last_job": "2026-09-04T06:48:50.2965509+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-04T06:48:50.2965509+00:00",
"modified_dateutc": "2026-09-04T06:48:50.2965509+00:00",
"is_mobile_installation": true
},
"job_type_id": "4a437188-38f9-4bd3-8b94-60ebabc76223",
"job_type_code": "sample string 7",
"job_type": {
"id": "d29bc407-1e6a-4567-9e99-1345577965cf",
"name": "sample string 2",
"sales_organization_id": "2a852df7-8a63-425a-91fc-9335ea7f6cc2",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-04T06:48:50.2965509+00:00",
"code": "sample string 7"
},
"job_priority_id": "6299bbeb-4515-464b-a814-3d6c2e9a95e8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "bdbac1f8-c4e8-4bf2-b746-f3cd6c181638",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "97e8c820-3ae6-464d-9411-af84f7f2ee38",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "32921a53-f6cb-4eef-9db4-5e440453ce98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1de4c84-a04b-4880-8cb6-91e88992adef",
"db_currency_id": "8495fab1-2971-493b-b8b3-e3c0d7a2ef83",
"db_language_id": "2e899658-ff2c-4605-8603-d2b8f755eaf1",
"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-04T06:48:50.2965509+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-04T06:48:50.2965509+00:00"
},
"job_status_id": "6e215ce1-f237-4efb-ba06-9a878bc4149d",
"job_status_code": "sample string 11",
"db_address_id": "cd2cce52-5c2e-406f-b894-2ad8524340c3",
"contact_id": "ffd61484-954f-497c-9f18-301c84fccb4e",
"requested_by_company_id": "51e119f1-3d09-43ad-b4f9-8a28da060722",
"requested_by_contact_id": "5407ff5b-a5ed-4c08-8513-960474cc06a4",
"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-04T06:48:50.2965509+00:00",
"due_date": "2026-09-04T06:48:50.2965509+00:00",
"date_create": "2026-09-04T06:48:50.2965509+00:00",
"date_update": "2026-09-04T06:48:50.2965509+00:00",
"date_closed": "2026-09-04T06:48:50.2965509+00:00",
"suggested_user_id": "d116c9ba-7b4c-410e-b485-ecb9f761af3b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "01519538-204a-4278-9b1f-cf68045924df",
"db_language_id": "d729ca1a-eee4-4130-b233-33781dc0eab2",
"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-04T06:48:50.2965509+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "79fb8d4f-8d15-498c-963e-346af6251707",
"sales_organization": {
"id": "32921a53-f6cb-4eef-9db4-5e440453ce98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1de4c84-a04b-4880-8cb6-91e88992adef",
"db_currency_id": "8495fab1-2971-493b-b8b3-e3c0d7a2ef83",
"db_language_id": "2e899658-ff2c-4605-8603-d2b8f755eaf1",
"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-04T06:48:50.2965509+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1aeb5baf-2be8-4b0c-90da-1e83e6f896c9",
"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": "067ca51b-10d8-46f7-880e-6f91e0dfa903",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-04T06:48:50.2965509+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "58cb5813-19c2-4050-a167-a059392b2f1a"
},
"suggested_date_start": "2026-09-04T06:48:50.2965509+00:00",
"skill_id": "5cdec4c3-d287-4577-824d-ee6e4429d577",
"skill_code": "sample string 32",
"skill": {
"id": "fa66e6d3-926a-4424-8cda-d0d6ca94d13e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f6dfa4c1-4683-4ed6-95a0-b67bc317ff7f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "32921a53-f6cb-4eef-9db4-5e440453ce98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1de4c84-a04b-4880-8cb6-91e88992adef",
"db_currency_id": "8495fab1-2971-493b-b8b3-e3c0d7a2ef83",
"db_language_id": "2e899658-ff2c-4605-8603-d2b8f755eaf1",
"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-04T06:48:50.2965509+00:00"
},
"modified_dateutc": "2026-09-04T06:48:50.2965509+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c4d5e0ad-5d32-4f5e-9e7b-9ab3514e5ef0",
"date_reported_by_company": "2026-09-04T06:48:50.2965509+00:00",
"id2": 36,
"company_id": "39daeafe-9eff-4164-999a-af7c601faad3",
"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": "f015a8fd-07e2-497c-8441-73a749e1dcbb",
"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-04T06:48:50.2965509+00:00"
},
"work_instruction_details_id": "afb1c91e-f412-4361-a817-ffd4e5f311a2",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3db5f5d7-fef6-4c15-9308-76ad98d33e21",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d805af15-d934-4d04-a98d-63d7e0b9d839",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-04T06:48:50.2965509+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": "d5281284-60cf-4610-949d-f6dbfe19ab74",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-04T06:48:50.2965509+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.