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": "c7d9576d-d3be-4a99-8909-8b0da1a362b5",
"jobs_id": "9fb4c495-bd34-400a-942f-47bc27f1ee1b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2991a4fa-15e5-4323-8e28-2ea9a4df30fd",
"_parent_id": "68cfae58-edca-4986-8bb1-ef1064398056",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "67e93ae3-236d-4e9f-af9b-743a02b5f7a0",
"project_reference_back_office": "sample string 5",
"project": {
"id": "18f76870-f776-41be-a7be-508992925eff",
"_parent_id": "30e452c6-554a-41f9-82af-b5a9b019f634",
"root_parent_id": "920e6a1c-27c4-475c-b3d9-f14b6d32ae58",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6bdbcc72-76d8-4d50-98e0-7a0da307aab6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "41d761d0-cdc4-4445-85fc-54147dfd5c19",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2cf16985-c99e-4db5-8b6a-55c93448b42e",
"_parent_code": "sample string 6",
"sales_organization_id": "77d77258-d54e-4f3f-83dd-0bc762ce851d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f125b053-75b0-453f-bdf4-43f2d235e05e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d12d19c0-58eb-4891-bf1c-28874a3e9f88",
"db_currency_id": "220e1282-6394-4ce3-9103-6a7d7ee7bded",
"db_language_id": "698febcc-8d28-4143-8969-8c27c733127b",
"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-10T21:21:07.3242303+00:00"
},
"modified_dateutc": "2026-08-10T21:21:07.3242303+00:00"
},
"equipment_model_id": "6633b361-525c-4cdd-8b86-ded12b3c7942",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f5fb9094-1099-4688-bec7-2737f7702eb4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6ff53acf-cf31-4c2a-b82d-86f4e4d11d3e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "450d74be-1ab3-4d97-9c8d-f0ab63bb33e2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1ae9420d-6407-4a45-ad38-1333b84ab40a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f125b053-75b0-453f-bdf4-43f2d235e05e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d12d19c0-58eb-4891-bf1c-28874a3e9f88",
"db_currency_id": "220e1282-6394-4ce3-9103-6a7d7ee7bded",
"db_language_id": "698febcc-8d28-4143-8969-8c27c733127b",
"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-10T21:21:07.3242303+00:00"
},
"modified_dateutc": "2026-08-10T21:21:07.3242303+00:00"
},
"equipment_family_id": "d904684a-560d-4bbc-a5d6-18ed1d4d91f7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "41d761d0-cdc4-4445-85fc-54147dfd5c19",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2cf16985-c99e-4db5-8b6a-55c93448b42e",
"_parent_code": "sample string 6",
"sales_organization_id": "77d77258-d54e-4f3f-83dd-0bc762ce851d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f125b053-75b0-453f-bdf4-43f2d235e05e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d12d19c0-58eb-4891-bf1c-28874a3e9f88",
"db_currency_id": "220e1282-6394-4ce3-9103-6a7d7ee7bded",
"db_language_id": "698febcc-8d28-4143-8969-8c27c733127b",
"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-10T21:21:07.3242303+00:00"
},
"modified_dateutc": "2026-08-10T21:21:07.3242303+00:00"
},
"date_in_production_since": "2026-08-10T21:21:07.3242303+00:00",
"date_out_of_production_since": "2026-08-10T21:21:07.3242303+00:00",
"date_end_support": "2026-08-10T21:21:07.3242303+00:00",
"sales_organization_id": "779f144b-8fec-48bd-93ef-284b0ad71855",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f125b053-75b0-453f-bdf4-43f2d235e05e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d12d19c0-58eb-4891-bf1c-28874a3e9f88",
"db_currency_id": "220e1282-6394-4ce3-9103-6a7d7ee7bded",
"db_language_id": "698febcc-8d28-4143-8969-8c27c733127b",
"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-10T21:21:07.3242303+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-10T21:21:07.3242303+00:00"
},
"project_status_id": "5ff92e97-91ec-44ea-ac16-a64de673ebdf",
"project_status_code": "sample string 10",
"project_status": {
"id": "1e2ac231-5b3f-483b-9265-547442600d94",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8b3b498a-34d7-43df-8e6a-548b660148c2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f125b053-75b0-453f-bdf4-43f2d235e05e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d12d19c0-58eb-4891-bf1c-28874a3e9f88",
"db_currency_id": "220e1282-6394-4ce3-9103-6a7d7ee7bded",
"db_language_id": "698febcc-8d28-4143-8969-8c27c733127b",
"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-10T21:21:07.3242303+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-10T21:21:07.3242303+00:00"
},
"company_id": "dabebb5c-e1f2-4c3a-a632-8593b2c5ca4c",
"company_code": "sample string 12",
"db_address_id": "10899dce-dee5-49dd-841b-bac991373d38",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6a27cdc7-4af0-4911-88f5-4bda74fe198f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a71289c1-2e52-4805-adb1-052d2a4ca759",
"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-10T21:21:07.3242303+00:00",
"date_create": "2026-08-10T21:21:07.3242303+00:00",
"date_update": "2026-08-10T21:21:07.3242303+00:00",
"updated_by_user_id": "68781ab9-c012-4c38-bb3d-86b1f0d554fb",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-10T21:21:07.3242303+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-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-10T21:21:07.3242303+00:00",
"date_last_job": "2026-08-10T21:21:07.3242303+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-10T21:21:07.3242303+00:00",
"modified_dateutc": "2026-08-10T21:21:07.3242303+00:00",
"is_mobile_installation": true
},
"job_type_id": "3128f5a0-3a33-49de-96dc-fbc16ed0f144",
"job_type_code": "sample string 7",
"job_type": {
"id": "4d408afe-d208-479f-9d49-d67f07c98d66",
"name": "sample string 2",
"sales_organization_id": "e5b4b262-ced5-41b9-915f-73058ffe21cc",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-10T21:21:07.3242303+00:00",
"code": "sample string 7"
},
"job_priority_id": "fd4bdb7d-0a8e-4912-bc2b-9032e0f3a191",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4528e79f-7bc9-43eb-9192-6f4fcd1ccfb4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8939ba2a-925d-422a-9121-417946d9ad0a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f125b053-75b0-453f-bdf4-43f2d235e05e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d12d19c0-58eb-4891-bf1c-28874a3e9f88",
"db_currency_id": "220e1282-6394-4ce3-9103-6a7d7ee7bded",
"db_language_id": "698febcc-8d28-4143-8969-8c27c733127b",
"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-10T21:21:07.3242303+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-10T21:21:07.3242303+00:00"
},
"job_status_id": "4bad7672-3b78-4b79-b8f6-1cd7bad269eb",
"job_status_code": "sample string 11",
"db_address_id": "e74ee755-60b2-49fa-9fde-d7aa0899abdb",
"contact_id": "84b4245f-c9fb-47b3-9217-fc2f3dcc3ede",
"requested_by_company_id": "aa96e084-f65d-468f-9b1c-2d5649eb7e91",
"requested_by_contact_id": "9e1ee50a-8d44-4c24-90d2-92c8b1c56fe2",
"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-10T21:21:07.3242303+00:00",
"due_date": "2026-08-10T21:21:07.3242303+00:00",
"date_create": "2026-08-10T21:21:07.3242303+00:00",
"date_update": "2026-08-10T21:21:07.3242303+00:00",
"date_closed": "2026-08-10T21:21:07.3242303+00:00",
"suggested_user_id": "5e392243-48a0-49fd-892d-f8e8a89752d0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9b8799af-d5fb-4487-9d04-4b09fabd4174",
"db_language_id": "7173ae12-f8a7-44ac-9e05-f2e0afe6e2d3",
"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-10T21:21:07.3242303+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "80792373-fa9c-4e40-9546-90d75fa7d142",
"sales_organization": {
"id": "f125b053-75b0-453f-bdf4-43f2d235e05e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d12d19c0-58eb-4891-bf1c-28874a3e9f88",
"db_currency_id": "220e1282-6394-4ce3-9103-6a7d7ee7bded",
"db_language_id": "698febcc-8d28-4143-8969-8c27c733127b",
"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-10T21:21:07.3242303+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f89c4a67-8de1-402e-bc8f-4c3f23e3088a",
"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": "039ce940-4d9a-45da-9e1c-3110712dfc27",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-10T21:21:07.3242303+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e930a218-a9be-4af6-8dc6-197c6489a483"
},
"suggested_date_start": "2026-08-10T21:21:07.3242303+00:00",
"skill_id": "83cc31f5-fd42-45d4-bc3e-04a985f3e92d",
"skill_code": "sample string 32",
"skill": {
"id": "75fd3249-188a-4992-9c14-9da45004cd0d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b80d6ba1-0f68-4db4-98c6-79c5557b9b2e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f125b053-75b0-453f-bdf4-43f2d235e05e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d12d19c0-58eb-4891-bf1c-28874a3e9f88",
"db_currency_id": "220e1282-6394-4ce3-9103-6a7d7ee7bded",
"db_language_id": "698febcc-8d28-4143-8969-8c27c733127b",
"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-10T21:21:07.3242303+00:00"
},
"modified_dateutc": "2026-08-10T21:21:07.3242303+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ec956dc3-f8c6-4e27-863d-0086548611ab",
"date_reported_by_company": "2026-08-10T21:21:07.3242303+00:00",
"id2": 36,
"company_id": "5ee906d6-d39b-41b6-acac-25eac32c9ca0",
"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": "3a352321-8df8-41b5-b6fd-4d35cfba4cf0",
"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-10T21:21:07.3242303+00:00"
},
"work_instruction_details_id": "2a9a35fd-30a3-401d-82d4-b45e4ca14997",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "829b6939-3cd7-466b-83c1-21eff1ff3055",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3394918b-cf3f-437b-97a2-b412b25ef391",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-10T21:21:07.3242303+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": "887caa06-78af-4c95-bbc9-232d6e6d6d4d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-10T21:21:07.3242303+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.