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": "56988621-d6ed-4ff1-b671-76bf071cc0c3",
"jobs_id": "02dc4630-eb78-460a-9501-f499c2a72a5d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "992e6b06-b1d2-4308-93ef-6698cd389cba",
"_parent_id": "276caf95-e1d1-46ae-a6bb-97f7a62ee804",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "80c0ad87-7cc1-4f67-b08d-d2dc82643e2a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b0f48d52-2e7d-4cff-80e3-75f7932f1da5",
"_parent_id": "e2025052-a2b3-4d5c-9a2a-238d3c015ae9",
"root_parent_id": "ea284eea-0749-4287-b94b-9e40135c17e8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "53668e81-38b1-451b-a5af-de6f30dec1c8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e37c4dc7-8479-4896-815b-d717ab1f6de7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e09dd392-fcd1-4691-ab73-f6095f825d27",
"_parent_code": "sample string 6",
"sales_organization_id": "e6218fe2-1366-468e-aa9e-d74a2e914db7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9664c427-a1fa-4c36-bb9b-70fc3e38155c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b682334-35a4-476e-b680-bbbe84e6d090",
"db_currency_id": "1e77b0b9-e02e-4d37-8e51-20549873721f",
"db_language_id": "8bc43c35-3c7a-4bb5-8d54-373fa18460db",
"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-08-20T19:13:55.3652961+00:00"
},
"modified_dateutc": "2026-08-20T19:13:55.3652961+00:00"
},
"equipment_model_id": "9eb618a3-412d-4ecb-9f3a-61b6dd1e21a7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b052f3f9-8c45-46b3-8494-a6ed222d1372",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ee048bf1-bff5-4552-bca8-9c8386d0ea32",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "01033b27-806b-4f5a-bb98-4dac61f390ce",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9e3e7b7a-b719-45fc-8847-9265ea7ea346",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9664c427-a1fa-4c36-bb9b-70fc3e38155c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b682334-35a4-476e-b680-bbbe84e6d090",
"db_currency_id": "1e77b0b9-e02e-4d37-8e51-20549873721f",
"db_language_id": "8bc43c35-3c7a-4bb5-8d54-373fa18460db",
"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-08-20T19:13:55.3652961+00:00"
},
"modified_dateutc": "2026-08-20T19:13:55.3652961+00:00"
},
"equipment_family_id": "c1ad42bb-8a59-4ca0-9f40-0db5a03f6fb8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e37c4dc7-8479-4896-815b-d717ab1f6de7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e09dd392-fcd1-4691-ab73-f6095f825d27",
"_parent_code": "sample string 6",
"sales_organization_id": "e6218fe2-1366-468e-aa9e-d74a2e914db7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9664c427-a1fa-4c36-bb9b-70fc3e38155c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b682334-35a4-476e-b680-bbbe84e6d090",
"db_currency_id": "1e77b0b9-e02e-4d37-8e51-20549873721f",
"db_language_id": "8bc43c35-3c7a-4bb5-8d54-373fa18460db",
"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-08-20T19:13:55.3652961+00:00"
},
"modified_dateutc": "2026-08-20T19:13:55.3652961+00:00"
},
"date_in_production_since": "2026-08-20T19:13:55.3652961+00:00",
"date_out_of_production_since": "2026-08-20T19:13:55.3652961+00:00",
"date_end_support": "2026-08-20T19:13:55.3652961+00:00",
"sales_organization_id": "912df9e6-80e0-4b27-8448-afe30154cf7d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9664c427-a1fa-4c36-bb9b-70fc3e38155c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b682334-35a4-476e-b680-bbbe84e6d090",
"db_currency_id": "1e77b0b9-e02e-4d37-8e51-20549873721f",
"db_language_id": "8bc43c35-3c7a-4bb5-8d54-373fa18460db",
"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-08-20T19:13:55.3652961+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-08-20T19:13:55.3652961+00:00"
},
"project_status_id": "171b1112-9b5b-44b9-9dfe-1e20fda8201f",
"project_status_code": "sample string 10",
"project_status": {
"id": "864e99cd-38f9-4871-a90a-eaedc7193fcb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2b0d24e1-0542-4448-bd48-ae944e68e7a6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9664c427-a1fa-4c36-bb9b-70fc3e38155c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b682334-35a4-476e-b680-bbbe84e6d090",
"db_currency_id": "1e77b0b9-e02e-4d37-8e51-20549873721f",
"db_language_id": "8bc43c35-3c7a-4bb5-8d54-373fa18460db",
"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-08-20T19:13:55.3652961+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-20T19:13:55.3652961+00:00"
},
"company_id": "fc64abf0-0c1f-4752-b52a-2ef03eaa1d6e",
"company_code": "sample string 12",
"db_address_id": "22912eb2-1c70-4e02-9632-9207fe133059",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f7d4647f-f300-4a08-8abc-b9a2b6533288",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "268886a5-58d9-4254-be7a-5d6937321f81",
"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-08-20T19:13:55.3652961+00:00",
"date_create": "2026-08-20T19:13:55.3652961+00:00",
"date_update": "2026-08-20T19:13:55.3652961+00:00",
"updated_by_user_id": "fc6f23f8-e674-4709-ab3c-3c9a5e80e725",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-20T19:13:55.3652961+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-08-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-20T19:13:55.3652961+00:00",
"date_last_job": "2026-08-20T19:13:55.3652961+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-20T19:13:55.3652961+00:00",
"modified_dateutc": "2026-08-20T19:13:55.3652961+00:00",
"is_mobile_installation": true
},
"job_type_id": "ccde2a77-4742-473e-b5fb-a796e5c98880",
"job_type_code": "sample string 7",
"job_type": {
"id": "0cd5ce29-97d2-4beb-90a9-0f523612a838",
"name": "sample string 2",
"sales_organization_id": "c5eb3bb7-dd6e-4c16-8ec3-7fa5c3b79e5e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-20T19:13:55.3652961+00:00",
"code": "sample string 7"
},
"job_priority_id": "bc4649d2-aeb7-44fb-9583-9bcc751f4fab",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "186b4220-4360-40ea-8967-4a8530360f9b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ba0b8389-2b7f-4efe-a378-ad82ad56a13e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9664c427-a1fa-4c36-bb9b-70fc3e38155c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b682334-35a4-476e-b680-bbbe84e6d090",
"db_currency_id": "1e77b0b9-e02e-4d37-8e51-20549873721f",
"db_language_id": "8bc43c35-3c7a-4bb5-8d54-373fa18460db",
"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-08-20T19:13:55.3652961+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-20T19:13:55.3652961+00:00"
},
"job_status_id": "a348ed79-f45e-48c6-85bc-9dd339025b88",
"job_status_code": "sample string 11",
"db_address_id": "d32f3521-5c46-4a04-a7f6-00f201c014d3",
"contact_id": "82579659-979a-4a4e-8bdd-b8d9d725accf",
"requested_by_company_id": "25bfce7d-7255-441c-ae6a-08ab911d8b11",
"requested_by_contact_id": "3e8cdee7-2c28-4767-8831-c844d210af75",
"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-08-20T19:13:55.3652961+00:00",
"due_date": "2026-08-20T19:13:55.3652961+00:00",
"date_create": "2026-08-20T19:13:55.3652961+00:00",
"date_update": "2026-08-20T19:13:55.3652961+00:00",
"date_closed": "2026-08-20T19:13:55.3652961+00:00",
"suggested_user_id": "549179a6-6a1b-40e7-ba75-c5fa4eaaffbc",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3684fced-cf93-426d-a70b-30a12c673a14",
"db_language_id": "6bf32f1c-c220-447c-905c-489b43475904",
"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-08-20T19:13:55.3652961+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a0bf98e8-d0e6-4ac0-afa9-68b8697a6fbb",
"sales_organization": {
"id": "9664c427-a1fa-4c36-bb9b-70fc3e38155c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b682334-35a4-476e-b680-bbbe84e6d090",
"db_currency_id": "1e77b0b9-e02e-4d37-8e51-20549873721f",
"db_language_id": "8bc43c35-3c7a-4bb5-8d54-373fa18460db",
"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-08-20T19:13:55.3652961+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "deccc217-ed97-4a8c-ba24-5103fa3b27cb",
"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": "7e6c7490-aabc-4f67-9d4e-dab5dbf3cb84",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-20T19:13:55.3652961+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8bda5dcb-f77a-4667-a390-a5ef87c21bcf"
},
"suggested_date_start": "2026-08-20T19:13:55.3652961+00:00",
"skill_id": "01ec07f5-0902-4df7-8366-2937a4aea9c0",
"skill_code": "sample string 32",
"skill": {
"id": "ba7a0928-55eb-4879-93f2-40c11626191e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "033329a8-e073-4d27-bb74-09886ab1e4cb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9664c427-a1fa-4c36-bb9b-70fc3e38155c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b682334-35a4-476e-b680-bbbe84e6d090",
"db_currency_id": "1e77b0b9-e02e-4d37-8e51-20549873721f",
"db_language_id": "8bc43c35-3c7a-4bb5-8d54-373fa18460db",
"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-08-20T19:13:55.3652961+00:00"
},
"modified_dateutc": "2026-08-20T19:13:55.3652961+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6d20b809-f3e4-47fd-948e-608960e829a3",
"date_reported_by_company": "2026-08-20T19:13:55.3652961+00:00",
"id2": 36,
"company_id": "86a26ab2-03ed-4a9a-85e4-338ce239b5b8",
"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": "cf2fb6ba-c898-4913-87af-b6126dbabdfc",
"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-08-20T19:13:55.3652961+00:00"
},
"work_instruction_details_id": "c08eb572-1831-4adc-a26c-bfabf62ae10d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "66523a36-4c2d-4ec1-8251-3240157af377",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9c952fb9-5463-49b0-b10d-bbf9e991eaf8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-20T19:13:55.3652961+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": "3741b160-0c1b-4748-8a29-1726dcd53008",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-20T19:13:55.3652961+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.