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": "8da22111-eb34-4840-99ec-1af9c17df36a",
"jobs_id": "5113b328-7cc7-45b2-8acf-55b969d934cf",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8d023619-d02f-43bf-9179-33fb88331a28",
"_parent_id": "e53840e3-c0d2-46a7-bb6a-7815850d2154",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3be5af27-da53-4956-bcb8-56c43ddf73f9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "120868f9-6129-4cd4-9499-235fe5d0eee4",
"_parent_id": "223b447d-afd4-41ea-b32e-2c529308ff7b",
"root_parent_id": "e8f892f8-b12b-489a-ad03-b6edec3ca1ff",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "93ce4f42-a206-4f43-b4d6-56e7b1331874",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "32960d71-3d53-4694-9337-64c05bd5d65b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "92a4508a-4c04-441f-a9f7-27318cb30a4e",
"_parent_code": "sample string 6",
"sales_organization_id": "c9e6d7e7-bcf8-434b-a4ee-408158852123",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ed7fdd85-b5c5-43a6-8160-7d02b8f1eee3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d314b1ac-e845-4101-a142-e1f9ae1d917b",
"db_currency_id": "46f8eb0e-8090-4b86-a2ac-2894059c6b7d",
"db_language_id": "65c2b0d1-4769-4440-9b1b-287faf32f595",
"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-03T18:12:57.2351175+00:00"
},
"modified_dateutc": "2026-11-03T18:12:57.2351175+00:00"
},
"equipment_model_id": "140bd9d7-69fc-48ea-a9af-b035751c71e9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "092bf3e8-6c37-4b9a-987d-b4846ef51a49",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "13c54022-2956-49cf-a94b-fa260c84a4ce",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f9251315-e3b1-4a62-8bdb-58f58e2ea3e6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e8239523-923d-44f1-af6c-66a2065a9866",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ed7fdd85-b5c5-43a6-8160-7d02b8f1eee3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d314b1ac-e845-4101-a142-e1f9ae1d917b",
"db_currency_id": "46f8eb0e-8090-4b86-a2ac-2894059c6b7d",
"db_language_id": "65c2b0d1-4769-4440-9b1b-287faf32f595",
"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-03T18:12:57.2351175+00:00"
},
"modified_dateutc": "2026-11-03T18:12:57.2351175+00:00"
},
"equipment_family_id": "8375fe75-4181-4d8d-9119-5d01a9006465",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "32960d71-3d53-4694-9337-64c05bd5d65b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "92a4508a-4c04-441f-a9f7-27318cb30a4e",
"_parent_code": "sample string 6",
"sales_organization_id": "c9e6d7e7-bcf8-434b-a4ee-408158852123",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ed7fdd85-b5c5-43a6-8160-7d02b8f1eee3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d314b1ac-e845-4101-a142-e1f9ae1d917b",
"db_currency_id": "46f8eb0e-8090-4b86-a2ac-2894059c6b7d",
"db_language_id": "65c2b0d1-4769-4440-9b1b-287faf32f595",
"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-03T18:12:57.2351175+00:00"
},
"modified_dateutc": "2026-11-03T18:12:57.2351175+00:00"
},
"date_in_production_since": "2026-11-03T18:12:57.2351175+00:00",
"date_out_of_production_since": "2026-11-03T18:12:57.2351175+00:00",
"date_end_support": "2026-11-03T18:12:57.2351175+00:00",
"sales_organization_id": "9a605be5-003e-4e55-8130-8c8ba83e2557",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ed7fdd85-b5c5-43a6-8160-7d02b8f1eee3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d314b1ac-e845-4101-a142-e1f9ae1d917b",
"db_currency_id": "46f8eb0e-8090-4b86-a2ac-2894059c6b7d",
"db_language_id": "65c2b0d1-4769-4440-9b1b-287faf32f595",
"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-03T18:12:57.2351175+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-03T18:12:57.2351175+00:00"
},
"project_status_id": "0e8b3968-64a2-483d-97ac-cb7f9941ef48",
"project_status_code": "sample string 10",
"project_status": {
"id": "8c655c0b-8600-46b5-b213-c0518b88c5ba",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "40b541dd-8bc1-4273-b7c0-d96aa8024dd1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ed7fdd85-b5c5-43a6-8160-7d02b8f1eee3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d314b1ac-e845-4101-a142-e1f9ae1d917b",
"db_currency_id": "46f8eb0e-8090-4b86-a2ac-2894059c6b7d",
"db_language_id": "65c2b0d1-4769-4440-9b1b-287faf32f595",
"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-03T18:12:57.2351175+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-03T18:12:57.2351175+00:00"
},
"company_id": "e4f5b725-8d2e-4016-9f01-9bc41e71ab5e",
"company_code": "sample string 12",
"db_address_id": "1edb4bf7-ca1f-4ba2-bc0f-4a8ffef658d3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1e7dc9fa-66eb-4147-a402-b69c06fef337",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8f7aaaa2-4275-4938-8bf7-7f0d992f68bb",
"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-03T18:12:57.2351175+00:00",
"date_create": "2026-11-03T18:12:57.2351175+00:00",
"date_update": "2026-11-03T18:12:57.2351175+00:00",
"updated_by_user_id": "24b53a06-4b55-4387-93d4-648734584e41",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-03T18:12:57.2351175+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-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-03T18:12:57.2351175+00:00",
"date_last_job": "2026-11-03T18:12:57.2351175+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-03T18:12:57.2351175+00:00",
"modified_dateutc": "2026-11-03T18:12:57.2351175+00:00",
"is_mobile_installation": true
},
"job_type_id": "b2fced18-0562-4c06-8c50-662ce6d1b70a",
"job_type_code": "sample string 7",
"job_type": {
"id": "7b26f882-6f81-408b-83e2-f91b82d9ee38",
"name": "sample string 2",
"sales_organization_id": "3569049f-315b-44cf-bb83-26c636ff6ee7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-03T18:12:57.2351175+00:00",
"code": "sample string 7"
},
"job_priority_id": "6997a24b-c54f-4996-833b-0fbf84a9faed",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "88800b9a-a135-4fb2-8a3d-27229ac6c8f8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "40673b7d-b9a2-411f-8c7b-57ae2800fa6a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ed7fdd85-b5c5-43a6-8160-7d02b8f1eee3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d314b1ac-e845-4101-a142-e1f9ae1d917b",
"db_currency_id": "46f8eb0e-8090-4b86-a2ac-2894059c6b7d",
"db_language_id": "65c2b0d1-4769-4440-9b1b-287faf32f595",
"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-03T18:12:57.2351175+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-03T18:12:57.2351175+00:00"
},
"job_status_id": "f3ee96ee-9f62-48bc-a98c-e6cb3ebcb9fc",
"job_status_code": "sample string 11",
"db_address_id": "ddf9ba85-2d41-4252-87dc-20b45dc230b3",
"contact_id": "b87adda4-5145-403d-9704-8276a3d958d1",
"requested_by_company_id": "bf1a8aab-27c4-47c3-ac7b-ccd1b9f22a9b",
"requested_by_contact_id": "4dee7032-a075-4174-ba2b-9560b1030f3e",
"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-03T18:12:57.2351175+00:00",
"due_date": "2026-11-03T18:12:57.2351175+00:00",
"date_create": "2026-11-03T18:12:57.2351175+00:00",
"date_update": "2026-11-03T18:12:57.2351175+00:00",
"date_closed": "2026-11-03T18:12:57.2351175+00:00",
"suggested_user_id": "2271f8b7-ce06-475b-9bbd-0fa38cd6cb63",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "46434185-b9ad-4556-9390-4cf9582392d4",
"db_language_id": "f44d47aa-eeab-43db-8a23-b361f9c0c0af",
"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-03T18:12:57.2351175+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "714dbc17-14f4-4f67-b236-5d577dfe5369",
"sales_organization": {
"id": "ed7fdd85-b5c5-43a6-8160-7d02b8f1eee3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d314b1ac-e845-4101-a142-e1f9ae1d917b",
"db_currency_id": "46f8eb0e-8090-4b86-a2ac-2894059c6b7d",
"db_language_id": "65c2b0d1-4769-4440-9b1b-287faf32f595",
"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-03T18:12:57.2351175+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "307d358c-4ffb-4bf8-993b-3d0761e86ae9",
"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": "c1def9af-cb58-4b80-8d5e-ace34d829fbd",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-03T18:12:57.2351175+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2b26aef5-7d80-4e47-8023-44c2219f1583"
},
"suggested_date_start": "2026-11-03T18:12:57.2351175+00:00",
"skill_id": "439f7b3c-a66b-4321-92bc-892835e2d2f3",
"skill_code": "sample string 32",
"skill": {
"id": "0cf8eb7a-439d-4f69-8339-b51e82d9faa4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4fb00518-5e5b-45a8-9bd4-90b64f32b85b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ed7fdd85-b5c5-43a6-8160-7d02b8f1eee3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d314b1ac-e845-4101-a142-e1f9ae1d917b",
"db_currency_id": "46f8eb0e-8090-4b86-a2ac-2894059c6b7d",
"db_language_id": "65c2b0d1-4769-4440-9b1b-287faf32f595",
"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-03T18:12:57.2351175+00:00"
},
"modified_dateutc": "2026-11-03T18:12:57.2513538+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "553259da-9c7a-4996-894a-cc1006768571",
"date_reported_by_company": "2026-11-03T18:12:57.2513538+00:00",
"id2": 36,
"company_id": "5ea0f561-7823-467c-a449-d2d0a2ad2099",
"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": "8298b3dc-dd64-49d2-bcfc-32cf6e651f67",
"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-03T18:12:57.2513538+00:00"
},
"work_instruction_details_id": "788fe8f1-21b5-4322-a940-43f6c2f59cbd",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9f2bf100-c915-4143-8a67-c5b0076f2fd8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "42fcfe11-9fcc-4825-8092-c2d34f1f3d59",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-03T18:12:57.2513538+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": "155a6f15-a9ff-4770-929e-a2f01ac997d2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-03T18:12:57.2513538+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.