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": "6c561c69-d977-430d-b3f4-a42d9feafea7",
"jobs_id": "7d62c039-ea7e-4849-89db-f9a8eecdc9fe",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "bcccbce2-59b5-4741-9ed9-e7b07b425ba5",
"_parent_id": "e814c7c2-e7cd-45f6-9769-b8e1844a84c1",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "04b9ac23-b52f-40bd-8431-c76dd2abdc33",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5c8db514-147f-4810-939b-5cd81b2e45c1",
"_parent_id": "f353c738-bcf1-4c99-810e-0950fc82196a",
"root_parent_id": "b5c59990-016c-40ed-b166-6b7f02700579",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "440dde44-3b82-4ec6-92c0-f99351f0cc1a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e332ffa5-99c8-43a6-9f55-e98c317ee1dc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "02c80930-afe9-4d14-8a0d-db1a471646e0",
"_parent_code": "sample string 6",
"sales_organization_id": "ea9bb641-6d5d-409a-b0e0-7182ffc011d1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "346bb9c6-3acf-4f5d-be83-7a619c9557f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d15b3b4-f4b6-4cec-91f6-0f5a8bc71943",
"db_currency_id": "e5f821f2-aa7e-41b6-b744-a8090790dd86",
"db_language_id": "146cc30d-a61e-445b-b365-9c0f2e02ec15",
"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-11-13T17:19:37.8744091+00:00"
},
"modified_dateutc": "2026-11-13T17:19:37.8744091+00:00"
},
"equipment_model_id": "857ab6c8-0836-439d-9ff0-9ed4d951baf4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a7ab0315-dea3-42dd-b409-6a6e71d52025",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0817d790-9681-47f1-86fe-a286f8ecdb01",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ec4fa5af-c2e8-43f7-8aaa-58320fc250f5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b3574350-9ad3-4668-bd74-7f72ff0f7407",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "346bb9c6-3acf-4f5d-be83-7a619c9557f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d15b3b4-f4b6-4cec-91f6-0f5a8bc71943",
"db_currency_id": "e5f821f2-aa7e-41b6-b744-a8090790dd86",
"db_language_id": "146cc30d-a61e-445b-b365-9c0f2e02ec15",
"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-11-13T17:19:37.8744091+00:00"
},
"modified_dateutc": "2026-11-13T17:19:37.8744091+00:00"
},
"equipment_family_id": "af6fdec1-7b2b-44c4-b2b9-c2bf5bfdaeb0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e332ffa5-99c8-43a6-9f55-e98c317ee1dc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "02c80930-afe9-4d14-8a0d-db1a471646e0",
"_parent_code": "sample string 6",
"sales_organization_id": "ea9bb641-6d5d-409a-b0e0-7182ffc011d1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "346bb9c6-3acf-4f5d-be83-7a619c9557f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d15b3b4-f4b6-4cec-91f6-0f5a8bc71943",
"db_currency_id": "e5f821f2-aa7e-41b6-b744-a8090790dd86",
"db_language_id": "146cc30d-a61e-445b-b365-9c0f2e02ec15",
"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-11-13T17:19:37.8744091+00:00"
},
"modified_dateutc": "2026-11-13T17:19:37.8744091+00:00"
},
"date_in_production_since": "2026-11-13T17:19:37.8744091+00:00",
"date_out_of_production_since": "2026-11-13T17:19:37.8744091+00:00",
"date_end_support": "2026-11-13T17:19:37.8744091+00:00",
"sales_organization_id": "7e1385cb-7559-452f-b758-9e5ad26bc7ba",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "346bb9c6-3acf-4f5d-be83-7a619c9557f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d15b3b4-f4b6-4cec-91f6-0f5a8bc71943",
"db_currency_id": "e5f821f2-aa7e-41b6-b744-a8090790dd86",
"db_language_id": "146cc30d-a61e-445b-b365-9c0f2e02ec15",
"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-11-13T17:19:37.8744091+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-11-13T17:19:37.8744091+00:00"
},
"project_status_id": "a61af016-9994-4a40-ada6-35f6ea0a2a61",
"project_status_code": "sample string 10",
"project_status": {
"id": "77d97961-76a8-4bac-9ae9-0759064e3b48",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "23b032fb-4584-4475-b112-32ff52bf3e5f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "346bb9c6-3acf-4f5d-be83-7a619c9557f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d15b3b4-f4b6-4cec-91f6-0f5a8bc71943",
"db_currency_id": "e5f821f2-aa7e-41b6-b744-a8090790dd86",
"db_language_id": "146cc30d-a61e-445b-b365-9c0f2e02ec15",
"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-11-13T17:19:37.8744091+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-13T17:19:37.8744091+00:00"
},
"company_id": "0a5b6fc2-09dc-4f10-b614-ea954eefebbf",
"company_code": "sample string 12",
"db_address_id": "3ce87714-bdec-4da0-87f1-32a28af20f4b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3dae159e-877e-4a24-a164-f022d3240958",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "36ce0e97-f7e7-4e1f-958b-028fcdb1e00d",
"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-11-13T17:19:37.8744091+00:00",
"date_create": "2026-11-13T17:19:37.8744091+00:00",
"date_update": "2026-11-13T17:19:37.8744091+00:00",
"updated_by_user_id": "868ebbf7-8466-432a-a23d-55abf42a3c97",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-13T17:19:37.8744091+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-11-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-13T17:19:37.8744091+00:00",
"date_last_job": "2026-11-13T17:19:37.8744091+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-13T17:19:37.8744091+00:00",
"modified_dateutc": "2026-11-13T17:19:37.8744091+00:00",
"is_mobile_installation": true
},
"job_type_id": "974aee29-9876-488c-b31b-e59d318c668d",
"job_type_code": "sample string 7",
"job_type": {
"id": "856f53ad-99b7-45e4-9bf7-8722090f64b8",
"name": "sample string 2",
"sales_organization_id": "2c6b8d58-403b-4757-81c6-087851b24208",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-13T17:19:37.8744091+00:00",
"code": "sample string 7"
},
"job_priority_id": "c47d8854-518f-4163-8be1-017cbf7cb203",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "19e8f38b-6521-4d3f-9090-994c27357f95",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8acbb2e3-9127-413f-8cd8-8587849675d8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "346bb9c6-3acf-4f5d-be83-7a619c9557f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d15b3b4-f4b6-4cec-91f6-0f5a8bc71943",
"db_currency_id": "e5f821f2-aa7e-41b6-b744-a8090790dd86",
"db_language_id": "146cc30d-a61e-445b-b365-9c0f2e02ec15",
"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-11-13T17:19:37.8744091+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-13T17:19:37.8744091+00:00"
},
"job_status_id": "5c1da0ea-7ab7-4cc9-aeff-bdbe82f0ac25",
"job_status_code": "sample string 11",
"db_address_id": "a3b4b9a6-28cc-4287-9447-24d18945da7b",
"contact_id": "4ab01e92-39c7-4970-b8bc-104882cf0086",
"requested_by_company_id": "3e32c297-ae2b-4c7c-8e6e-f592eb56a151",
"requested_by_contact_id": "450b54b2-9671-470a-9a0a-ce4f3854f689",
"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-11-13T17:19:37.8744091+00:00",
"due_date": "2026-11-13T17:19:37.8744091+00:00",
"date_create": "2026-11-13T17:19:37.8744091+00:00",
"date_update": "2026-11-13T17:19:37.8744091+00:00",
"date_closed": "2026-11-13T17:19:37.8744091+00:00",
"suggested_user_id": "23a02459-ec08-4dc2-b8f2-4f244547285d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8ae42b6b-705a-42df-b32a-757b1e5f9811",
"db_language_id": "4fb9645c-70e0-4134-97bb-76ad225aa827",
"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-11-13T17:19:37.8744091+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a8fd6b42-1c47-4ed3-8d0e-7f85f126566d",
"sales_organization": {
"id": "346bb9c6-3acf-4f5d-be83-7a619c9557f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d15b3b4-f4b6-4cec-91f6-0f5a8bc71943",
"db_currency_id": "e5f821f2-aa7e-41b6-b744-a8090790dd86",
"db_language_id": "146cc30d-a61e-445b-b365-9c0f2e02ec15",
"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-11-13T17:19:37.8744091+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c7061c2b-a124-464f-80d6-1dd35d613f0a",
"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": "b7660c8d-e397-41cd-8c0b-7bbc856d0c90",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-13T17:19:37.8744091+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3f3ecac6-20cd-4d9e-8b39-1f0fb060f027"
},
"suggested_date_start": "2026-11-13T17:19:37.8744091+00:00",
"skill_id": "e43e2e09-08c0-4adb-a62f-9e863492956d",
"skill_code": "sample string 32",
"skill": {
"id": "25daab31-5b8c-4f8c-89db-4cd0c05096da",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "04a57d2e-46a2-4f3c-a8f4-a73e6c217e11",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "346bb9c6-3acf-4f5d-be83-7a619c9557f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d15b3b4-f4b6-4cec-91f6-0f5a8bc71943",
"db_currency_id": "e5f821f2-aa7e-41b6-b744-a8090790dd86",
"db_language_id": "146cc30d-a61e-445b-b365-9c0f2e02ec15",
"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-11-13T17:19:37.8744091+00:00"
},
"modified_dateutc": "2026-11-13T17:19:37.8906649+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ba75ed6c-2fd5-4590-9eca-48cc636efe0d",
"date_reported_by_company": "2026-11-13T17:19:37.8906649+00:00",
"id2": 36,
"company_id": "1432bc7e-eebd-444c-a411-9a2e9d87cbaa",
"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": "5c86ca70-2134-4d4f-b9b9-139ace09bd89",
"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-11-13T17:19:37.8906649+00:00"
},
"work_instruction_details_id": "98330df1-3915-4bcd-8ed7-a0f4fede47b1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "15df728a-b6ef-4470-96fe-b01848302204",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9ab7de90-8d81-4787-8474-75c3d9d4757e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-13T17:19:37.8906649+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": "28bd85d7-1641-4fa3-85a7-1c2c5f496d94",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-13T17:19:37.8906649+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.