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
{
"id": "fe3c6cf1-b34b-4525-a9e7-a639a2994b3d",
"jobs_id": "401a5805-9795-45f9-853b-70d0c0deb2a4",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "aecee12f-7447-4b55-a656-90da2aeec1e3",
"_parent_id": "1ea71e3b-83c2-48c3-b448-1c282ff97285",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "594c9a24-916c-40ea-863e-d08c93181b10",
"project_reference_back_office": "sample string 5",
"project": {
"id": "802c2d7c-a555-4cb1-8753-58bc213c04db",
"_parent_id": "b4404796-3f71-46b4-bcfa-07e7ae3d9cb9",
"root_parent_id": "86f5889a-7718-4898-a0b3-447334fa59f6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7807f326-2d71-4345-bf46-0d9f6bd77b7d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5128b08c-dc2c-4a37-baeb-8183dd768a65",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "521a7c2d-bd58-4872-9377-f46ee7c6b77a",
"_parent_code": "sample string 6",
"sales_organization_id": "a9db3e9b-3ac8-48a6-beb6-148ad916532a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "126429d3-9c19-4315-8720-ceb9dfd769c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63fbb75f-f125-4bd0-8cae-53550654707e",
"db_currency_id": "c2e00305-c5bd-46ac-8d95-37ee71376bc0",
"db_language_id": "4ce8c091-9f88-4b78-a634-5e675602ff4a",
"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-17T19:13:17.294236+00:00"
},
"modified_dateutc": "2026-11-17T19:13:17.294236+00:00"
},
"equipment_model_id": "ad329b55-d5f1-438e-8029-b57525f9de4e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e0e1a91f-71c5-4dd8-9799-140d0100c25e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c65ebf26-1663-4d93-812e-5b842f9ff3d5",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2f4f9270-613d-4777-8a41-4e07555d4810",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c9d743f3-13bf-46e1-9518-bc3d0c29b417",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "126429d3-9c19-4315-8720-ceb9dfd769c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63fbb75f-f125-4bd0-8cae-53550654707e",
"db_currency_id": "c2e00305-c5bd-46ac-8d95-37ee71376bc0",
"db_language_id": "4ce8c091-9f88-4b78-a634-5e675602ff4a",
"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-17T19:13:17.294236+00:00"
},
"modified_dateutc": "2026-11-17T19:13:17.294236+00:00"
},
"equipment_family_id": "104dba34-cd0b-41b3-aa6f-0c6dd3ccfa2c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5128b08c-dc2c-4a37-baeb-8183dd768a65",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "521a7c2d-bd58-4872-9377-f46ee7c6b77a",
"_parent_code": "sample string 6",
"sales_organization_id": "a9db3e9b-3ac8-48a6-beb6-148ad916532a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "126429d3-9c19-4315-8720-ceb9dfd769c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63fbb75f-f125-4bd0-8cae-53550654707e",
"db_currency_id": "c2e00305-c5bd-46ac-8d95-37ee71376bc0",
"db_language_id": "4ce8c091-9f88-4b78-a634-5e675602ff4a",
"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-17T19:13:17.294236+00:00"
},
"modified_dateutc": "2026-11-17T19:13:17.294236+00:00"
},
"date_in_production_since": "2026-11-17T19:13:17.294236+00:00",
"date_out_of_production_since": "2026-11-17T19:13:17.294236+00:00",
"date_end_support": "2026-11-17T19:13:17.294236+00:00",
"sales_organization_id": "73df3ad8-9f40-4366-ba0d-44aff05568a9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "126429d3-9c19-4315-8720-ceb9dfd769c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63fbb75f-f125-4bd0-8cae-53550654707e",
"db_currency_id": "c2e00305-c5bd-46ac-8d95-37ee71376bc0",
"db_language_id": "4ce8c091-9f88-4b78-a634-5e675602ff4a",
"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-17T19:13:17.294236+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-17T19:13:17.294236+00:00"
},
"project_status_id": "c0e05ec4-358c-499b-a382-c6d08fb95896",
"project_status_code": "sample string 10",
"project_status": {
"id": "4aa6fb04-80e0-4e8d-b545-7f4e33997a7b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5bcb8fbc-8815-4a2a-b5d2-dc5b8acd5ee2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "126429d3-9c19-4315-8720-ceb9dfd769c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63fbb75f-f125-4bd0-8cae-53550654707e",
"db_currency_id": "c2e00305-c5bd-46ac-8d95-37ee71376bc0",
"db_language_id": "4ce8c091-9f88-4b78-a634-5e675602ff4a",
"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-17T19:13:17.294236+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-17T19:13:17.294236+00:00"
},
"company_id": "006d1116-3dbd-4da4-8c4f-25bd3041ed41",
"company_code": "sample string 12",
"db_address_id": "ade7b501-bd57-4ef2-9331-181f811ebf14",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3ffbde40-ce27-4b1d-bdca-53a565ce00c7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "fecee881-ee4e-417e-b0d4-c902259574b6",
"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-17T19:13:17.294236+00:00",
"date_create": "2026-11-17T19:13:17.294236+00:00",
"date_update": "2026-11-17T19:13:17.294236+00:00",
"updated_by_user_id": "8a8dac7c-46fc-4354-a32f-6412c3e27852",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-17T19:13:17.294236+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-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-17T19:13:17.294236+00:00",
"date_last_job": "2026-11-17T19:13:17.294236+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-17T19:13:17.294236+00:00",
"modified_dateutc": "2026-11-17T19:13:17.294236+00:00",
"is_mobile_installation": true
},
"job_type_id": "08adbb82-5191-4669-89fb-0bcfd9c44caf",
"job_type_code": "sample string 7",
"job_type": {
"id": "0fd848f5-3445-4f7f-a931-522bfb63811e",
"name": "sample string 2",
"sales_organization_id": "41c6aa1c-af42-461d-be06-35289b0234ab",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-17T19:13:17.294236+00:00",
"code": "sample string 7"
},
"job_priority_id": "3d8566df-07b2-4715-8db0-6d48778695b9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "01f3339f-9625-4f80-993e-3be722b9b79a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d5b3829f-9098-47f5-8f05-627652a4b130",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "126429d3-9c19-4315-8720-ceb9dfd769c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63fbb75f-f125-4bd0-8cae-53550654707e",
"db_currency_id": "c2e00305-c5bd-46ac-8d95-37ee71376bc0",
"db_language_id": "4ce8c091-9f88-4b78-a634-5e675602ff4a",
"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-17T19:13:17.294236+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-17T19:13:17.294236+00:00"
},
"job_status_id": "83aeb783-f729-425d-8ff9-aedcd53255f3",
"job_status_code": "sample string 11",
"db_address_id": "d6f8fc77-6886-4c65-82d6-d0c49cc1a033",
"contact_id": "bd665dbe-f7e1-4461-92f2-c3f5b1ddfea2",
"requested_by_company_id": "2f71f111-9655-41e0-b8ea-fc7972493a65",
"requested_by_contact_id": "5395646d-3a7b-4427-b586-3e0aecfdbd81",
"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-17T19:13:17.294236+00:00",
"due_date": "2026-11-17T19:13:17.294236+00:00",
"date_create": "2026-11-17T19:13:17.294236+00:00",
"date_update": "2026-11-17T19:13:17.294236+00:00",
"date_closed": "2026-11-17T19:13:17.294236+00:00",
"suggested_user_id": "6fbd36f6-fb26-461b-b4f6-4dd4edf5589a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "030faf6c-b2a1-4f8c-8e58-9089facd0920",
"db_language_id": "61036d8f-765a-40f4-a905-5f68f0179279",
"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-17T19:13:17.294236+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9b7ca2b0-ed4b-41a5-b941-1a20e43a841b",
"sales_organization": {
"id": "126429d3-9c19-4315-8720-ceb9dfd769c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63fbb75f-f125-4bd0-8cae-53550654707e",
"db_currency_id": "c2e00305-c5bd-46ac-8d95-37ee71376bc0",
"db_language_id": "4ce8c091-9f88-4b78-a634-5e675602ff4a",
"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-17T19:13:17.294236+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "942b8982-0222-4c96-ac98-84812d4835b3",
"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": "a3159d41-eb6a-41ba-901f-5522d11ea19e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-17T19:13:17.294236+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "965c2d18-ae61-4055-8509-f85b476a8dc1"
},
"suggested_date_start": "2026-11-17T19:13:17.294236+00:00",
"skill_id": "9604dab5-b2ed-4507-9ec3-8ad8452a9032",
"skill_code": "sample string 32",
"skill": {
"id": "21d5ac1f-f321-4760-bd94-52353ba80c54",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "047d4f7a-5c4a-4986-83e0-1453c89b2249",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "126429d3-9c19-4315-8720-ceb9dfd769c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63fbb75f-f125-4bd0-8cae-53550654707e",
"db_currency_id": "c2e00305-c5bd-46ac-8d95-37ee71376bc0",
"db_language_id": "4ce8c091-9f88-4b78-a634-5e675602ff4a",
"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-17T19:13:17.294236+00:00"
},
"modified_dateutc": "2026-11-17T19:13:17.294236+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2e36c925-f11f-49c8-a30f-517a3dd89b47",
"date_reported_by_company": "2026-11-17T19:13:17.294236+00:00",
"id2": 36,
"company_id": "a1998894-dfd4-4d50-8303-9047be91a089",
"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": "cf101deb-cba8-421a-9776-76f7ea158e1d",
"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-17T19:13:17.294236+00:00"
},
"work_instruction_details_id": "f3bef8cb-f73d-4ff4-8dbb-3b2f95338428",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "77fc9ce1-9116-48d2-9b37-465500b334a7",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e715a0d7-4d37-4255-a3e2-5a0b5e72bf33",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-17T19:13:17.294236+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": "e57c1d7c-a012-4832-87b8-df829a1d6f97",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-17T19:13:17.294236+00:00"
}