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": "ca6c1f2c-dac2-4efc-9581-f2aa4c304679",
"jobs_id": "5e6b8f3f-29f9-46b0-b496-9f338820adf7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5d5017ee-b3ed-4b6b-95b3-f79103af84ff",
"_parent_id": "903484af-8930-4863-95ad-a5f8a36fd403",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d616e690-fc35-45f6-9af7-de4b9156a17b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ab24329f-b063-44bf-ae54-6f06c689cc6d",
"_parent_id": "fc8cf986-9b20-47fa-abf5-438bd8ad5b6e",
"root_parent_id": "14ff2800-81b7-4b83-8682-e02f0dd9bc00",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e8c1ffb8-b833-41ab-8d18-ad063c07c648",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f20f7605-edf7-458b-8a2d-5b233344f4a0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b8f310df-48a7-47ab-8824-955e4c91a7c8",
"_parent_code": "sample string 6",
"sales_organization_id": "0c229610-5add-4437-ad39-cca35924ff5b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2c4f5bdd-1c88-4863-84c4-633cec441037",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5588a07-b0d3-466e-a473-138d83d6884f",
"db_currency_id": "4f5e17bd-a971-454b-bfbe-74e6dc78db00",
"db_language_id": "d8cd168a-f437-41a9-97e7-c2c4fa8236f9",
"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-07-18T07:27:52.8738125+00:00"
},
"modified_dateutc": "2026-07-18T07:27:52.8738125+00:00"
},
"equipment_model_id": "edbbe5e3-cee7-4062-8c19-cc066af6418e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6366b1ca-5883-4837-b6ef-e5ce4462b9b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ae410f46-16e3-4b2d-9f5f-128f872b2490",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4c67b8fb-c3ba-46e6-8714-d4348fc528d7",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a338c6f5-dec0-4b54-9045-a4d1db644891",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2c4f5bdd-1c88-4863-84c4-633cec441037",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5588a07-b0d3-466e-a473-138d83d6884f",
"db_currency_id": "4f5e17bd-a971-454b-bfbe-74e6dc78db00",
"db_language_id": "d8cd168a-f437-41a9-97e7-c2c4fa8236f9",
"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-07-18T07:27:52.8738125+00:00"
},
"modified_dateutc": "2026-07-18T07:27:52.8738125+00:00"
},
"equipment_family_id": "aa5d1bd8-e15e-4d00-969d-bd6d757c01ab",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f20f7605-edf7-458b-8a2d-5b233344f4a0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b8f310df-48a7-47ab-8824-955e4c91a7c8",
"_parent_code": "sample string 6",
"sales_organization_id": "0c229610-5add-4437-ad39-cca35924ff5b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2c4f5bdd-1c88-4863-84c4-633cec441037",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5588a07-b0d3-466e-a473-138d83d6884f",
"db_currency_id": "4f5e17bd-a971-454b-bfbe-74e6dc78db00",
"db_language_id": "d8cd168a-f437-41a9-97e7-c2c4fa8236f9",
"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-07-18T07:27:52.8738125+00:00"
},
"modified_dateutc": "2026-07-18T07:27:52.8738125+00:00"
},
"date_in_production_since": "2026-07-18T07:27:52.8738125+00:00",
"date_out_of_production_since": "2026-07-18T07:27:52.8738125+00:00",
"date_end_support": "2026-07-18T07:27:52.8738125+00:00",
"sales_organization_id": "bcc40e25-1164-4666-9adc-a05be79d37f4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2c4f5bdd-1c88-4863-84c4-633cec441037",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5588a07-b0d3-466e-a473-138d83d6884f",
"db_currency_id": "4f5e17bd-a971-454b-bfbe-74e6dc78db00",
"db_language_id": "d8cd168a-f437-41a9-97e7-c2c4fa8236f9",
"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-07-18T07:27:52.8738125+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-07-18T07:27:52.8738125+00:00"
},
"project_status_id": "7a1ad2e4-b83c-42a6-be5b-54f91abfcaa8",
"project_status_code": "sample string 10",
"project_status": {
"id": "3d1df032-b0c0-4597-83b2-f515ef2482dd",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "02594974-aa01-44aa-a996-5f19086c529c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2c4f5bdd-1c88-4863-84c4-633cec441037",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5588a07-b0d3-466e-a473-138d83d6884f",
"db_currency_id": "4f5e17bd-a971-454b-bfbe-74e6dc78db00",
"db_language_id": "d8cd168a-f437-41a9-97e7-c2c4fa8236f9",
"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-07-18T07:27:52.8738125+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-18T07:27:52.8738125+00:00"
},
"company_id": "5cc84dc7-691e-472e-8767-07e8ad57586c",
"company_code": "sample string 12",
"db_address_id": "6d9bc5dd-7ada-48af-a9c3-db500949c310",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f332c6f0-5c20-4fbf-b1e7-27f79329f0fe",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "60bbd15f-9397-47ee-b6f8-9703a73ace06",
"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-07-18T07:27:52.8738125+00:00",
"date_create": "2026-07-18T07:27:52.8738125+00:00",
"date_update": "2026-07-18T07:27:52.8738125+00:00",
"updated_by_user_id": "a74e14a3-ad87-43c9-b2d4-3b0a9398a027",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-18T07:27:52.8738125+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-07-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-18T07:27:52.8738125+00:00",
"date_last_job": "2026-07-18T07:27:52.8738125+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-18T07:27:52.8738125+00:00",
"modified_dateutc": "2026-07-18T07:27:52.8738125+00:00",
"is_mobile_installation": true
},
"job_type_id": "c109132c-3b61-4d52-ac25-f4622d1228bf",
"job_type_code": "sample string 7",
"job_type": {
"id": "ad604856-51d7-4200-b5bf-d8a6833f2fcb",
"name": "sample string 2",
"sales_organization_id": "de4fc855-e2c3-4d1d-b9e0-7a8927f104b5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-18T07:27:52.8738125+00:00",
"code": "sample string 7"
},
"job_priority_id": "05d1bc7c-3dc9-421d-8438-9fef7c8d6598",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0b3ccb57-0cbc-4cbd-ba37-d0924af5f6ea",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e2cea86f-4ba2-46ef-9e25-45e7515dd38d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2c4f5bdd-1c88-4863-84c4-633cec441037",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5588a07-b0d3-466e-a473-138d83d6884f",
"db_currency_id": "4f5e17bd-a971-454b-bfbe-74e6dc78db00",
"db_language_id": "d8cd168a-f437-41a9-97e7-c2c4fa8236f9",
"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-07-18T07:27:52.8738125+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-18T07:27:52.8738125+00:00"
},
"job_status_id": "760ebe5f-304f-4d83-9754-6fa2b6963094",
"job_status_code": "sample string 11",
"db_address_id": "e8f74b92-95d1-4729-9f8c-338473ad23c4",
"contact_id": "17f1b9c7-97d0-439e-b939-a39663238b33",
"requested_by_company_id": "5af5bb9b-e3da-49a4-bcc7-b001cc507e0d",
"requested_by_contact_id": "bf7aef6c-a1f8-4d74-bdfd-c525c13c3c94",
"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-07-18T07:27:52.8738125+00:00",
"due_date": "2026-07-18T07:27:52.8738125+00:00",
"date_create": "2026-07-18T07:27:52.8738125+00:00",
"date_update": "2026-07-18T07:27:52.8738125+00:00",
"date_closed": "2026-07-18T07:27:52.8738125+00:00",
"suggested_user_id": "028b03cf-86d1-4b5b-9af4-9325ad081952",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9f36b2da-a7e9-4d8b-aa3a-620077a7cdeb",
"db_language_id": "8848de4f-456d-4a37-8a57-958b77949fb2",
"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-07-18T07:27:52.8738125+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8bcc2797-0a61-48de-8c83-894ef0da79ce",
"sales_organization": {
"id": "2c4f5bdd-1c88-4863-84c4-633cec441037",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5588a07-b0d3-466e-a473-138d83d6884f",
"db_currency_id": "4f5e17bd-a971-454b-bfbe-74e6dc78db00",
"db_language_id": "d8cd168a-f437-41a9-97e7-c2c4fa8236f9",
"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-07-18T07:27:52.8738125+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "be7421d5-cf35-4c53-b3d6-2c9e75c2c82b",
"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": "37512fc6-7c75-4f6e-bd6d-eb5ca289302d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-18T07:27:52.8738125+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "eb56d6ec-e087-4542-870e-307a57631696"
},
"suggested_date_start": "2026-07-18T07:27:52.8738125+00:00",
"skill_id": "3175fe5f-e40a-44de-99a1-4f3757571236",
"skill_code": "sample string 32",
"skill": {
"id": "73ecd5e1-64d9-4ddf-a460-be680549eeab",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "adb94c4d-c14d-4f2e-88aa-247b81ce6f4d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2c4f5bdd-1c88-4863-84c4-633cec441037",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5588a07-b0d3-466e-a473-138d83d6884f",
"db_currency_id": "4f5e17bd-a971-454b-bfbe-74e6dc78db00",
"db_language_id": "d8cd168a-f437-41a9-97e7-c2c4fa8236f9",
"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-07-18T07:27:52.8738125+00:00"
},
"modified_dateutc": "2026-07-18T07:27:52.8738125+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1d60372e-f444-4ccc-8184-c78c259a3f29",
"date_reported_by_company": "2026-07-18T07:27:52.8738125+00:00",
"id2": 36,
"company_id": "3f3ba1d1-a7f7-4d83-80e2-e67abc28f009",
"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": "99d1d8d4-d30d-4d45-8892-fdfd91ee167a",
"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-07-18T07:27:52.8738125+00:00"
},
"work_instruction_details_id": "16cfa73a-5dbc-4873-a82e-e70facc2381f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0dc927c8-aae1-46a1-bff1-14c50909ce02",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "abd65305-c470-42b4-a9f3-a481b6a5b5fd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-18T07:27:52.8738125+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": "513e2301-feda-42e2-9f48-59f5e0fcd1a6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-18T07:27:52.8738125+00:00"
}