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": "d24a58c7-2381-4f93-aa64-178c2da6e58b",
"jobs_id": "95728502-e037-4a2b-9c04-8220b27eeb20",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6cdfd143-849b-4788-8670-ed08a71d0da4",
"_parent_id": "91c2186a-3ce6-42f8-97e6-9d42c58dc206",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b44c5473-4285-4f83-8b68-a3a86d535329",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f475f0e5-2437-4c18-98d9-fbf9e437c72a",
"_parent_id": "e13cc56c-1f38-407f-a157-c4c25d1ce503",
"root_parent_id": "a8a04526-cdf5-44cb-9f60-2c183192380b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6ee618ed-911d-48f8-9399-a7186896262c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "37741bba-70af-4de7-b4ee-d7db29669e2a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "71b1798e-4c94-4a92-8499-2bc24817723f",
"_parent_code": "sample string 6",
"sales_organization_id": "6d1f8478-2fe1-48a9-b883-c3d58d8a39ee",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e774e70f-ae8b-40ff-9ca9-0344d9eb60a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a447cc04-fdd7-4f5c-bf6a-f2c75c9a4972",
"db_currency_id": "d5c973ed-c855-4e0b-98ca-6f0bca42b8d4",
"db_language_id": "8f85d6f9-813c-4b9d-86d5-3af148a5787c",
"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-05-03T05:22:20.8081695+00:00"
},
"modified_dateutc": "2026-05-03T05:22:20.8081695+00:00"
},
"equipment_model_id": "f5e0293a-dba2-44a0-bac0-1d5c65d95f2c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "38ca70fd-881a-4de5-8ea3-9aea17efd3fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "81137a45-c898-44fc-acb7-03df94a088ca",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "344865be-6acb-418f-a675-340b3ef392bf",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f05de0eb-d260-4716-a6ca-927eccc6f8f9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e774e70f-ae8b-40ff-9ca9-0344d9eb60a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a447cc04-fdd7-4f5c-bf6a-f2c75c9a4972",
"db_currency_id": "d5c973ed-c855-4e0b-98ca-6f0bca42b8d4",
"db_language_id": "8f85d6f9-813c-4b9d-86d5-3af148a5787c",
"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-05-03T05:22:20.8081695+00:00"
},
"modified_dateutc": "2026-05-03T05:22:20.8081695+00:00"
},
"equipment_family_id": "7777789f-4aee-487f-994b-8faad86ef382",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "37741bba-70af-4de7-b4ee-d7db29669e2a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "71b1798e-4c94-4a92-8499-2bc24817723f",
"_parent_code": "sample string 6",
"sales_organization_id": "6d1f8478-2fe1-48a9-b883-c3d58d8a39ee",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e774e70f-ae8b-40ff-9ca9-0344d9eb60a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a447cc04-fdd7-4f5c-bf6a-f2c75c9a4972",
"db_currency_id": "d5c973ed-c855-4e0b-98ca-6f0bca42b8d4",
"db_language_id": "8f85d6f9-813c-4b9d-86d5-3af148a5787c",
"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-05-03T05:22:20.8081695+00:00"
},
"modified_dateutc": "2026-05-03T05:22:20.8081695+00:00"
},
"date_in_production_since": "2026-05-03T05:22:20.8081695+00:00",
"date_out_of_production_since": "2026-05-03T05:22:20.8081695+00:00",
"date_end_support": "2026-05-03T05:22:20.8081695+00:00",
"sales_organization_id": "a4c35fd0-7538-444d-8de5-70cf88e6cb0e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e774e70f-ae8b-40ff-9ca9-0344d9eb60a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a447cc04-fdd7-4f5c-bf6a-f2c75c9a4972",
"db_currency_id": "d5c973ed-c855-4e0b-98ca-6f0bca42b8d4",
"db_language_id": "8f85d6f9-813c-4b9d-86d5-3af148a5787c",
"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-05-03T05:22:20.8081695+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-05-03T05:22:20.8081695+00:00"
},
"project_status_id": "ec2930a7-4dba-44a0-b815-5a25dd8ca89a",
"project_status_code": "sample string 10",
"project_status": {
"id": "e99d6ff3-4f2a-4b46-94a9-c161ed6125e5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8fef06b5-982e-4358-a2b8-e7f41652d96b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e774e70f-ae8b-40ff-9ca9-0344d9eb60a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a447cc04-fdd7-4f5c-bf6a-f2c75c9a4972",
"db_currency_id": "d5c973ed-c855-4e0b-98ca-6f0bca42b8d4",
"db_language_id": "8f85d6f9-813c-4b9d-86d5-3af148a5787c",
"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-05-03T05:22:20.8081695+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-03T05:22:20.8081695+00:00"
},
"company_id": "40a52984-6736-4e37-835b-c4fcc682420b",
"company_code": "sample string 12",
"db_address_id": "42deffcd-68d9-4623-bd92-45b485975c1c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8dc9ba76-75be-48f8-8857-c36878741965",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a90bdae6-23bb-46f5-93a7-bae21ad24661",
"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-05-03T05:22:20.8081695+00:00",
"date_create": "2026-05-03T05:22:20.8081695+00:00",
"date_update": "2026-05-03T05:22:20.8081695+00:00",
"updated_by_user_id": "b3b19872-daf5-4f68-a479-8112b44027e5",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-03T05:22:20.8081695+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-05-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-03T05:22:20.8081695+00:00",
"date_last_job": "2026-05-03T05:22:20.8081695+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-03T05:22:20.8081695+00:00",
"modified_dateutc": "2026-05-03T05:22:20.8081695+00:00",
"is_mobile_installation": true
},
"job_type_id": "d1e421c0-5f7f-47d5-ab2d-8e35c63354a1",
"job_type_code": "sample string 7",
"job_type": {
"id": "0045570a-4ceb-4046-a003-e70fa4ce9808",
"name": "sample string 2",
"sales_organization_id": "223f2524-1bc8-4199-a852-05beb49f9865",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-03T05:22:20.8081695+00:00",
"code": "sample string 7"
},
"job_priority_id": "6132260d-61c6-4ba3-bb5d-88dd7dcd7e53",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f68efc65-05c1-43cf-a01e-47e32df35d84",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b67dcf04-6c00-417e-bafe-e03942c96047",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e774e70f-ae8b-40ff-9ca9-0344d9eb60a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a447cc04-fdd7-4f5c-bf6a-f2c75c9a4972",
"db_currency_id": "d5c973ed-c855-4e0b-98ca-6f0bca42b8d4",
"db_language_id": "8f85d6f9-813c-4b9d-86d5-3af148a5787c",
"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-05-03T05:22:20.8081695+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-03T05:22:20.8081695+00:00"
},
"job_status_id": "e8b0761c-4aad-41fe-b877-7f3c95d7f423",
"job_status_code": "sample string 11",
"db_address_id": "b6cfe6ff-2c2d-4fe0-9cb3-9585e2839b72",
"contact_id": "3c0788fd-e6c6-4b75-8366-d99c1208ca29",
"requested_by_company_id": "588419fa-0b59-452a-8428-424a66e41605",
"requested_by_contact_id": "e353b938-cff1-4b49-82da-f6b326a56063",
"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-05-03T05:22:20.8081695+00:00",
"due_date": "2026-05-03T05:22:20.8081695+00:00",
"date_create": "2026-05-03T05:22:20.8081695+00:00",
"date_update": "2026-05-03T05:22:20.8081695+00:00",
"date_closed": "2026-05-03T05:22:20.8081695+00:00",
"suggested_user_id": "096a35a8-df5c-4eba-81fd-31dfbbc1634e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5dadd918-2a7d-4b2a-a81f-dd84e1a43d13",
"db_language_id": "80dc3476-0f0d-4533-bc05-a6219054985f",
"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-05-03T05:22:20.8081695+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "178ea2d9-f153-4a8b-b0fa-5e23744e8e54",
"sales_organization": {
"id": "e774e70f-ae8b-40ff-9ca9-0344d9eb60a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a447cc04-fdd7-4f5c-bf6a-f2c75c9a4972",
"db_currency_id": "d5c973ed-c855-4e0b-98ca-6f0bca42b8d4",
"db_language_id": "8f85d6f9-813c-4b9d-86d5-3af148a5787c",
"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-05-03T05:22:20.8081695+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1915e632-aff2-4ac8-b7b6-d3b935e2930d",
"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": "18958765-7f73-41db-9961-79d4e573fef2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-03T05:22:20.8081695+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "bcd4f6ce-0f94-4ed5-b199-15b077183c65"
},
"suggested_date_start": "2026-05-03T05:22:20.8081695+00:00",
"skill_id": "34a0091f-4c95-4548-a7be-2753402c0429",
"skill_code": "sample string 32",
"skill": {
"id": "001d7fe1-5603-4126-a2cf-e5bf1f53f2e3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "777ae45d-ea49-4f46-94a3-c4b03970861c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e774e70f-ae8b-40ff-9ca9-0344d9eb60a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a447cc04-fdd7-4f5c-bf6a-f2c75c9a4972",
"db_currency_id": "d5c973ed-c855-4e0b-98ca-6f0bca42b8d4",
"db_language_id": "8f85d6f9-813c-4b9d-86d5-3af148a5787c",
"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-05-03T05:22:20.8081695+00:00"
},
"modified_dateutc": "2026-05-03T05:22:20.8081695+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "671fbe82-f3a1-4f83-a5bc-4c73e1196dfc",
"date_reported_by_company": "2026-05-03T05:22:20.8081695+00:00",
"id2": 36,
"company_id": "ec69da24-d7ed-4060-9528-e8828cd0ed75",
"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": "0a52321e-7564-47a6-8a9f-4218b78ee38f",
"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-05-03T05:22:20.8081695+00:00"
},
"work_instruction_details_id": "fcdcfb6e-e70d-4a67-830e-6dec62c3a42f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "88464d03-3425-4cce-8ddb-f32117043856",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "567435e7-0508-405a-9cdc-7687dac7d65a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-03T05:22:20.8081695+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": "7f3d35fc-0a67-4eab-8153-72cfaf96830e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-03T05:22:20.8081695+00:00"
}