Retrieves all the job work instruction list.
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
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 |
Response Formats
application/json, text/json
Sample:
{
"id": "47d20f05-63d1-4282-bf5f-ca62622237d9",
"jobs_id": "5b2b39ab-e0d6-4ad0-8f40-698cd983833e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "965ca8e1-e816-4a9c-91be-f96be776e588",
"_parent_id": "4bbf4ff0-b31e-4e29-8f0a-af86d709883f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "84a61be2-0f86-42a3-bd7b-e91cf5c37eeb",
"project_reference_back_office": "sample string 5",
"project": {
"id": "34b6062d-79cd-423c-9bec-dc936d000be9",
"_parent_id": "3e6d097e-a9e0-487c-bc7c-ab1fa23f52c0",
"root_parent_id": "5d87164a-9c15-4033-80c3-b2344e76ecee",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c712a2a5-8d42-4210-ae4a-dbf4e0d88040",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "de594cb9-c9e5-4208-b873-1afa4d2a8bbe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ecc54369-2830-48b2-bbdf-24d8006e2834",
"_parent_code": "sample string 6",
"sales_organization_id": "fb3b0e74-bb50-4723-b60c-44991bd524b1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "393e0504-0850-4d90-8e53-c29142007304",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "11d869a9-7ab6-4941-bc02-deee2a80814d",
"db_currency_id": "ef8a4d9b-006a-4195-a1a3-a2ee3c898ee5",
"db_language_id": "2c32014d-42c6-4a82-9bfe-222e2cce90e3",
"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": "2025-09-03T06:40:27.2910321+00:00"
},
"modified_dateutc": "2025-09-03T06:40:27.2910321+00:00"
},
"equipment_model_id": "d7a02505-730d-4a0f-b3ae-9d1cd4948615",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "82e69de5-ae2f-4cc8-a035-a9269b70f508",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4ec26f67-e929-4fb3-8015-4022559a9cfa",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b2226353-c065-4245-a442-e49cc2e02b35",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "caea30dc-74c1-4a2a-935e-6d7efbba7e8d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "393e0504-0850-4d90-8e53-c29142007304",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "11d869a9-7ab6-4941-bc02-deee2a80814d",
"db_currency_id": "ef8a4d9b-006a-4195-a1a3-a2ee3c898ee5",
"db_language_id": "2c32014d-42c6-4a82-9bfe-222e2cce90e3",
"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": "2025-09-03T06:40:27.2910321+00:00"
},
"modified_dateutc": "2025-09-03T06:40:27.2910321+00:00"
},
"equipment_family_id": "f088e42a-8eff-44d1-aebb-e3920ff16fb6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "de594cb9-c9e5-4208-b873-1afa4d2a8bbe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ecc54369-2830-48b2-bbdf-24d8006e2834",
"_parent_code": "sample string 6",
"sales_organization_id": "fb3b0e74-bb50-4723-b60c-44991bd524b1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "393e0504-0850-4d90-8e53-c29142007304",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "11d869a9-7ab6-4941-bc02-deee2a80814d",
"db_currency_id": "ef8a4d9b-006a-4195-a1a3-a2ee3c898ee5",
"db_language_id": "2c32014d-42c6-4a82-9bfe-222e2cce90e3",
"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": "2025-09-03T06:40:27.2910321+00:00"
},
"modified_dateutc": "2025-09-03T06:40:27.2910321+00:00"
},
"date_in_production_since": "2025-09-03T06:40:27.2910321+00:00",
"date_out_of_production_since": "2025-09-03T06:40:27.2910321+00:00",
"date_end_support": "2025-09-03T06:40:27.2910321+00:00",
"sales_organization_id": "fe46918b-0455-4896-a43c-65256db407ff",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "393e0504-0850-4d90-8e53-c29142007304",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "11d869a9-7ab6-4941-bc02-deee2a80814d",
"db_currency_id": "ef8a4d9b-006a-4195-a1a3-a2ee3c898ee5",
"db_language_id": "2c32014d-42c6-4a82-9bfe-222e2cce90e3",
"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": "2025-09-03T06:40:27.2910321+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": "2025-09-03T06:40:27.2910321+00:00"
},
"project_status_id": "4781a293-dc2e-44ae-a25a-c6d982e47d80",
"project_status_code": "sample string 10",
"project_status": {
"id": "c4f95513-693e-48d8-9e78-29826f4e45f6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "aceee058-5771-4fe9-8271-1fc5a78bbef6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "393e0504-0850-4d90-8e53-c29142007304",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "11d869a9-7ab6-4941-bc02-deee2a80814d",
"db_currency_id": "ef8a4d9b-006a-4195-a1a3-a2ee3c898ee5",
"db_language_id": "2c32014d-42c6-4a82-9bfe-222e2cce90e3",
"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": "2025-09-03T06:40:27.2910321+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-03T06:40:27.2910321+00:00"
},
"company_id": "3555d291-1ad0-44a2-adcd-c9c5a0b675f3",
"company_code": "sample string 12",
"db_address_id": "75cb7ed8-b357-43d7-9461-49c68b12d28c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "fe992672-8624-47b3-947f-e3cd64475b4a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1121389a-e4b0-41ca-abc6-3b1da621df3d",
"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": "2025-09-03T06:40:27.2910321+00:00",
"date_create": "2025-09-03T06:40:27.2910321+00:00",
"date_update": "2025-09-03T06:40:27.2910321+00:00",
"updated_by_user_id": "4a423dd4-79dd-4a6a-8709-c76eb2017730",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-09-03T06:40:27.2910321+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": "2025-09-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-09-03T06:40:27.2910321+00:00",
"date_last_job": "2025-09-03T06:40:27.2910321+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-09-03T06:40:27.2910321+00:00",
"modified_dateutc": "2025-09-03T06:40:27.2910321+00:00",
"is_mobile_installation": true
},
"job_type_id": "4d7e896e-6c57-419c-99fc-73b4ae5db138",
"job_type_code": "sample string 7",
"job_type": {
"id": "833509b3-0400-4813-9146-042c65826f93",
"name": "sample string 2",
"sales_organization_id": "6b435b89-87cb-44c9-bb8e-5b75cba9af41",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-09-03T06:40:27.2910321+00:00",
"code": "sample string 7"
},
"job_priority_id": "a7e5e815-5daf-4bc7-ae75-8d690fd62fc0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7fa5f303-b7d7-4f67-bd0b-c552d8bbed4a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f096bc51-269f-47c1-8f21-6a61917fbf0f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "393e0504-0850-4d90-8e53-c29142007304",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "11d869a9-7ab6-4941-bc02-deee2a80814d",
"db_currency_id": "ef8a4d9b-006a-4195-a1a3-a2ee3c898ee5",
"db_language_id": "2c32014d-42c6-4a82-9bfe-222e2cce90e3",
"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": "2025-09-03T06:40:27.2910321+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-03T06:40:27.2910321+00:00"
},
"job_status_id": "9e73b842-c654-4823-8afa-baf5eb2e38c1",
"job_status_code": "sample string 11",
"db_address_id": "df024e56-c82c-49e1-885c-06786d08bfbc",
"contact_id": "d5c17d7c-ccb4-4633-ad94-9ae853cc9c24",
"requested_by_company_id": "106478b3-6705-4dd0-a53a-5e6fe43865e6",
"requested_by_contact_id": "08e065d3-0b52-4a1a-ba81-023e06791a2c",
"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": "2025-09-03T06:40:27.2910321+00:00",
"due_date": "2025-09-03T06:40:27.2910321+00:00",
"date_create": "2025-09-03T06:40:27.2910321+00:00",
"date_update": "2025-09-03T06:40:27.2910321+00:00",
"date_closed": "2025-09-03T06:40:27.2910321+00:00",
"suggested_user_id": "473cf4b2-9da2-4ad0-817f-ad8533aa8119",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9aa04547-71aa-4b59-a0e4-334d5d350caa",
"db_language_id": "d75044ff-4e8a-48f5-b12d-44cf212aae96",
"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": "2025-09-03T06:40:27.2910321+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e3b66e18-ce85-4609-8fca-e889f076dc9b",
"sales_organization": {
"id": "393e0504-0850-4d90-8e53-c29142007304",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "11d869a9-7ab6-4941-bc02-deee2a80814d",
"db_currency_id": "ef8a4d9b-006a-4195-a1a3-a2ee3c898ee5",
"db_language_id": "2c32014d-42c6-4a82-9bfe-222e2cce90e3",
"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": "2025-09-03T06:40:27.2910321+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9a58fc9b-7865-4399-8184-45eb1e829e45",
"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": "cbdf65e8-828b-4c32-b6a9-3cd1507034f6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-09-03T06:40:27.2910321+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1c0495c4-7ed7-4ff9-a37e-302f4a94e3d8"
},
"suggested_date_start": "2025-09-03T06:40:27.2910321+00:00",
"skill_id": "b0e011f4-5806-4ad1-a2c7-70baa08cd543",
"skill_code": "sample string 32",
"skill": {
"id": "f2c7222a-2f1d-4a60-9fa4-364a0fd816b7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a2783c27-84a8-4c39-8cb1-dc1cee393f17",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "393e0504-0850-4d90-8e53-c29142007304",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "11d869a9-7ab6-4941-bc02-deee2a80814d",
"db_currency_id": "ef8a4d9b-006a-4195-a1a3-a2ee3c898ee5",
"db_language_id": "2c32014d-42c6-4a82-9bfe-222e2cce90e3",
"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": "2025-09-03T06:40:27.2910321+00:00"
},
"modified_dateutc": "2025-09-03T06:40:27.2910321+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "be328941-a538-4cb0-a017-9eb12ebca364",
"date_reported_by_company": "2025-09-03T06:40:27.2910321+00:00",
"id2": 36,
"company_id": "546b6ee7-5ee3-4785-b640-c8b07efcdec0",
"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": "2d74aec2-9ee4-486d-b2c7-29c5fc5a2f34",
"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": "2025-09-03T06:40:27.2910321+00:00"
},
"work_instruction_details_id": "d2ea39e2-be8e-4eca-8baf-ac04b493008b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e909d21d-f29e-40c4-a576-517d1cf56c0f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "63fbaf31-1e89-4e8d-ab92-32dbed3cd371",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-09-03T06:40:27.2910321+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": "cc2f957c-3c20-406b-a261-4d3b2c668302",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-09-03T06:40:27.2910321+00:00"
}