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": "02ffa312-7aed-4f17-80ed-16219d3e7374",
"jobs_id": "7257679a-baac-412f-996c-a57763cf6e73",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "294a9bb7-68a1-4d93-9352-05cb08b63dd8",
"_parent_id": "f4f6cd74-3590-4ed2-814d-616236ad2b1f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "96e72054-f7b8-46dc-a355-90bcf9f75bb3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d0f34634-10ae-423a-ab9a-a71b8f38820e",
"_parent_id": "1edd1e0a-f639-498f-9631-d92008f4f5a9",
"root_parent_id": "adada239-bfd6-48b5-bb60-5ec5555fc1d6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ea0fff65-d6f8-4ea1-88d0-5b87a8e0cb59",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "82ca2c9d-56f1-4ed8-b3a5-99ba22bff9ec",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b91e58f7-cade-4dc6-92bd-00fae67dd3f6",
"_parent_code": "sample string 6",
"sales_organization_id": "eeb6af41-afd6-4097-9a98-3fe4a0ef95ee",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1fd3ede0-988c-45a7-978d-a2b36a6feed4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1eecb04a-7688-4cb5-b6fb-cd8f2456ad20",
"db_currency_id": "c9c4d2c9-1416-4a92-907d-1b3d7c45724d",
"db_language_id": "28fb0327-86e0-441e-b0dc-409f2aa211ca",
"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-04-17T05:51:02.9244003+00:00"
},
"modified_dateutc": "2026-04-17T05:51:02.9244003+00:00"
},
"equipment_model_id": "09e99d49-db45-4f26-9443-cde18fe627da",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8c3af534-be70-4a6a-b077-07cae5819310",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "46b96d5a-dc5b-4992-87e8-da11c081d819",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "64ec2b32-bbcb-40eb-81ab-a0ae5ea1a445",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "15f6f19d-2011-4eac-820f-63008200f47b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1fd3ede0-988c-45a7-978d-a2b36a6feed4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1eecb04a-7688-4cb5-b6fb-cd8f2456ad20",
"db_currency_id": "c9c4d2c9-1416-4a92-907d-1b3d7c45724d",
"db_language_id": "28fb0327-86e0-441e-b0dc-409f2aa211ca",
"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-04-17T05:51:02.9244003+00:00"
},
"modified_dateutc": "2026-04-17T05:51:02.940027+00:00"
},
"equipment_family_id": "8f6a1187-4e29-4d2f-ae5e-9bfb428eaad6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "82ca2c9d-56f1-4ed8-b3a5-99ba22bff9ec",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b91e58f7-cade-4dc6-92bd-00fae67dd3f6",
"_parent_code": "sample string 6",
"sales_organization_id": "eeb6af41-afd6-4097-9a98-3fe4a0ef95ee",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1fd3ede0-988c-45a7-978d-a2b36a6feed4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1eecb04a-7688-4cb5-b6fb-cd8f2456ad20",
"db_currency_id": "c9c4d2c9-1416-4a92-907d-1b3d7c45724d",
"db_language_id": "28fb0327-86e0-441e-b0dc-409f2aa211ca",
"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-04-17T05:51:02.9244003+00:00"
},
"modified_dateutc": "2026-04-17T05:51:02.9244003+00:00"
},
"date_in_production_since": "2026-04-17T05:51:02.940027+00:00",
"date_out_of_production_since": "2026-04-17T05:51:02.940027+00:00",
"date_end_support": "2026-04-17T05:51:02.940027+00:00",
"sales_organization_id": "b4027c4e-c05b-4782-8fea-532e1ead9bd8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1fd3ede0-988c-45a7-978d-a2b36a6feed4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1eecb04a-7688-4cb5-b6fb-cd8f2456ad20",
"db_currency_id": "c9c4d2c9-1416-4a92-907d-1b3d7c45724d",
"db_language_id": "28fb0327-86e0-441e-b0dc-409f2aa211ca",
"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-04-17T05:51:02.9244003+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-04-17T05:51:02.940027+00:00"
},
"project_status_id": "ce30f6d1-cdc8-44c3-8c31-5ef05c0cff46",
"project_status_code": "sample string 10",
"project_status": {
"id": "69ecc7d2-a95e-4709-80df-1f4488eeec8b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b9cac89f-f77e-4dbd-9492-9ca9a35a354f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1fd3ede0-988c-45a7-978d-a2b36a6feed4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1eecb04a-7688-4cb5-b6fb-cd8f2456ad20",
"db_currency_id": "c9c4d2c9-1416-4a92-907d-1b3d7c45724d",
"db_language_id": "28fb0327-86e0-441e-b0dc-409f2aa211ca",
"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-04-17T05:51:02.9244003+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-17T05:51:02.940027+00:00"
},
"company_id": "f8b72db4-3ab6-4bee-b8ea-9a32576eaf02",
"company_code": "sample string 12",
"db_address_id": "d5768f23-86c3-441e-ae4c-eea42aaa39b4",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "254b88b7-769c-4258-96a8-d26750196730",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7f687f24-64cd-4f26-8d32-48f4ad2907af",
"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-04-17T05:51:02.940027+00:00",
"date_create": "2026-04-17T05:51:02.940027+00:00",
"date_update": "2026-04-17T05:51:02.940027+00:00",
"updated_by_user_id": "f4ee61e9-6797-4b93-be04-3ee9a8a1916a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-17T05:51:02.940027+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-04-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-17T05:51:02.940027+00:00",
"date_last_job": "2026-04-17T05:51:02.940027+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-17T05:51:02.940027+00:00",
"modified_dateutc": "2026-04-17T05:51:02.940027+00:00",
"is_mobile_installation": true
},
"job_type_id": "19a74283-4fbe-4605-aa61-80bdcb870d0a",
"job_type_code": "sample string 7",
"job_type": {
"id": "bfdf2d5c-f92d-49f2-803c-bb24d2054489",
"name": "sample string 2",
"sales_organization_id": "1c2c29ee-5334-44df-be0c-fedd2fc255a8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-17T05:51:02.940027+00:00",
"code": "sample string 7"
},
"job_priority_id": "7868429d-4ddd-402f-9dc4-cffd00977246",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2e23222c-45b3-4fda-80fe-c1a67246094f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4256f91f-53f3-43ba-b6fc-0dfc55afb3a8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1fd3ede0-988c-45a7-978d-a2b36a6feed4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1eecb04a-7688-4cb5-b6fb-cd8f2456ad20",
"db_currency_id": "c9c4d2c9-1416-4a92-907d-1b3d7c45724d",
"db_language_id": "28fb0327-86e0-441e-b0dc-409f2aa211ca",
"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-04-17T05:51:02.9244003+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-17T05:51:02.940027+00:00"
},
"job_status_id": "fd704dbd-4e0a-4433-bd65-4648828e1f1f",
"job_status_code": "sample string 11",
"db_address_id": "9b6dc46c-8a2c-457a-8665-41871eb04b78",
"contact_id": "bf674812-079d-4ee3-8f14-0b1d0eab00b0",
"requested_by_company_id": "8f0059fc-92fc-432c-a9f0-fb8cf77f7d83",
"requested_by_contact_id": "d5340b5e-12cf-4036-9c4d-18c4afb49510",
"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-04-17T05:51:02.940027+00:00",
"due_date": "2026-04-17T05:51:02.940027+00:00",
"date_create": "2026-04-17T05:51:02.940027+00:00",
"date_update": "2026-04-17T05:51:02.940027+00:00",
"date_closed": "2026-04-17T05:51:02.940027+00:00",
"suggested_user_id": "dbe84661-3529-420d-9c20-89447f6d7163",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b610bb77-a635-4d1c-8e73-a87c08fb1f5d",
"db_language_id": "599d4255-de02-44b2-99b2-5d70c78835d4",
"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-04-17T05:51:02.940027+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "88e30e10-1c4e-4b3d-bd85-dfd7ff338023",
"sales_organization": {
"id": "1fd3ede0-988c-45a7-978d-a2b36a6feed4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1eecb04a-7688-4cb5-b6fb-cd8f2456ad20",
"db_currency_id": "c9c4d2c9-1416-4a92-907d-1b3d7c45724d",
"db_language_id": "28fb0327-86e0-441e-b0dc-409f2aa211ca",
"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-04-17T05:51:02.9244003+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6d78a14f-4f8f-47ad-9225-8f0a718a5611",
"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": "eea64703-f983-4433-8012-8b07ae4878a2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-17T05:51:02.940027+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3afea327-fa21-41c9-90d0-0dd57d335a2b"
},
"suggested_date_start": "2026-04-17T05:51:02.940027+00:00",
"skill_id": "bee5756a-b90f-4e33-9d6b-1331ce6765ca",
"skill_code": "sample string 32",
"skill": {
"id": "fcc5d0b4-e88d-4160-9825-8a652c5bdf50",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4bcf03a0-d5c4-44f5-8063-3443f78cf221",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1fd3ede0-988c-45a7-978d-a2b36a6feed4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1eecb04a-7688-4cb5-b6fb-cd8f2456ad20",
"db_currency_id": "c9c4d2c9-1416-4a92-907d-1b3d7c45724d",
"db_language_id": "28fb0327-86e0-441e-b0dc-409f2aa211ca",
"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-04-17T05:51:02.9244003+00:00"
},
"modified_dateutc": "2026-04-17T05:51:02.940027+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8f52e6ef-7cfc-4d94-96a8-9b7ea3d1f383",
"date_reported_by_company": "2026-04-17T05:51:02.940027+00:00",
"id2": 36,
"company_id": "a9855d49-7bb2-4b99-8bbd-26ae0656f7b0",
"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": "5e5adab7-ec65-4558-bd4d-a3f9e7ec6767",
"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-04-17T05:51:02.940027+00:00"
},
"work_instruction_details_id": "c2a0386d-2c64-4b7a-8cf0-38a42796ca08",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "73717d57-01d5-4469-8a2f-f163ea3d194f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "557eb796-bddc-4d6b-ab63-b147b0361b5d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-17T05:51:02.940027+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": "93259488-1db6-4582-92ed-acf6781e0716",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-17T05:51:02.940027+00:00"
}