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": "805b00de-6898-4df0-bf3c-8f287333b597",
"jobs_id": "8370bc85-ad5c-4d6b-8204-bb91b353fa02",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3dca6fa7-b175-40c3-821d-6d3cfc0c9354",
"_parent_id": "366f716e-66df-41f5-9314-8e4dd15ea79c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c7a63f22-6c0f-4330-933c-beaed4a23fbb",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8e3a5580-cda6-4d21-8239-09e36a1f96f3",
"_parent_id": "ac8a793b-a706-4688-92ed-4c14f739c4b5",
"root_parent_id": "902874c3-72b3-45a9-bf5e-5afebecd1ffc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a105f397-4da6-4be9-86a2-baf0f1474bc1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "178d6175-7008-4081-8e14-244d0b7815e1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6b62feef-3679-45e6-b4fa-682aa522e7f2",
"_parent_code": "sample string 6",
"sales_organization_id": "c39337ff-e1dc-4070-ab04-e14585fa5b4a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "32991c13-071d-4ecf-900a-e816ea9a0786",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00a8aacb-d9b2-4f58-822b-8c26f28890b4",
"db_currency_id": "9220518c-ca8b-4b1d-b0a0-04bea9e3b981",
"db_language_id": "d447fe96-e1b3-4d85-a0a2-08dd799a2a31",
"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-28T12:21:36.2256601+00:00"
},
"modified_dateutc": "2026-07-28T12:21:36.2256601+00:00"
},
"equipment_model_id": "9f3e4692-3a33-4dfd-bbff-4bcb569c7bbc",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6aee765b-a211-4643-91b1-eceb7beae9e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f1ded329-bc15-48bc-9459-8d157230e1d4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "908c675d-6f1f-4150-b87a-c13f7bb9ac5a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "bf04d529-c37e-44ce-a932-7da4ada6f4e4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "32991c13-071d-4ecf-900a-e816ea9a0786",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00a8aacb-d9b2-4f58-822b-8c26f28890b4",
"db_currency_id": "9220518c-ca8b-4b1d-b0a0-04bea9e3b981",
"db_language_id": "d447fe96-e1b3-4d85-a0a2-08dd799a2a31",
"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-28T12:21:36.2256601+00:00"
},
"modified_dateutc": "2026-07-28T12:21:36.2256601+00:00"
},
"equipment_family_id": "664ab845-ec55-4dc0-9675-cdb5dc2bb18c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "178d6175-7008-4081-8e14-244d0b7815e1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6b62feef-3679-45e6-b4fa-682aa522e7f2",
"_parent_code": "sample string 6",
"sales_organization_id": "c39337ff-e1dc-4070-ab04-e14585fa5b4a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "32991c13-071d-4ecf-900a-e816ea9a0786",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00a8aacb-d9b2-4f58-822b-8c26f28890b4",
"db_currency_id": "9220518c-ca8b-4b1d-b0a0-04bea9e3b981",
"db_language_id": "d447fe96-e1b3-4d85-a0a2-08dd799a2a31",
"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-28T12:21:36.2256601+00:00"
},
"modified_dateutc": "2026-07-28T12:21:36.2256601+00:00"
},
"date_in_production_since": "2026-07-28T12:21:36.2256601+00:00",
"date_out_of_production_since": "2026-07-28T12:21:36.2256601+00:00",
"date_end_support": "2026-07-28T12:21:36.2256601+00:00",
"sales_organization_id": "51b43d22-0302-4952-8a97-9b11c1f7fe9a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "32991c13-071d-4ecf-900a-e816ea9a0786",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00a8aacb-d9b2-4f58-822b-8c26f28890b4",
"db_currency_id": "9220518c-ca8b-4b1d-b0a0-04bea9e3b981",
"db_language_id": "d447fe96-e1b3-4d85-a0a2-08dd799a2a31",
"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-28T12:21:36.2256601+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-28T12:21:36.2256601+00:00"
},
"project_status_id": "a6b04563-b828-4f65-850a-605d07e53e1f",
"project_status_code": "sample string 10",
"project_status": {
"id": "55a45c6c-8c18-40f0-bab4-7cf7c613b22d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b5477291-f82e-4cb2-b45b-0fe39c7b6137",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "32991c13-071d-4ecf-900a-e816ea9a0786",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00a8aacb-d9b2-4f58-822b-8c26f28890b4",
"db_currency_id": "9220518c-ca8b-4b1d-b0a0-04bea9e3b981",
"db_language_id": "d447fe96-e1b3-4d85-a0a2-08dd799a2a31",
"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-28T12:21:36.2256601+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-28T12:21:36.2256601+00:00"
},
"company_id": "03c98ba3-8665-4347-8ae3-216aa310c3ed",
"company_code": "sample string 12",
"db_address_id": "0226d78c-a61a-45b8-80dc-e5915a7431f8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f1768997-c2f2-4dd0-931c-284ded810c18",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6542d02c-77be-4128-a0d7-b31c6b349bc4",
"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-28T12:21:36.2256601+00:00",
"date_create": "2026-07-28T12:21:36.2256601+00:00",
"date_update": "2026-07-28T12:21:36.2256601+00:00",
"updated_by_user_id": "ec058b18-0431-4472-ace5-92fa1fbc4417",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-28T12:21:36.2256601+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-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-28T12:21:36.2256601+00:00",
"date_last_job": "2026-07-28T12:21:36.2256601+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-28T12:21:36.2256601+00:00",
"modified_dateutc": "2026-07-28T12:21:36.2256601+00:00",
"is_mobile_installation": true
},
"job_type_id": "47c38e11-a296-4753-ba00-20c4348620a2",
"job_type_code": "sample string 7",
"job_type": {
"id": "a7ddbc82-3fde-45b0-8ff4-582c26edb498",
"name": "sample string 2",
"sales_organization_id": "01c41515-3ecc-492c-ae8e-b6c4cbab7048",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-28T12:21:36.2256601+00:00",
"code": "sample string 7"
},
"job_priority_id": "bc1a703b-b498-488c-82d0-eab28da16495",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "19a0b8a2-aead-4d47-b195-81a5d8a02d09",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "89e1c244-eacb-44c4-8824-9829c2415607",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "32991c13-071d-4ecf-900a-e816ea9a0786",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00a8aacb-d9b2-4f58-822b-8c26f28890b4",
"db_currency_id": "9220518c-ca8b-4b1d-b0a0-04bea9e3b981",
"db_language_id": "d447fe96-e1b3-4d85-a0a2-08dd799a2a31",
"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-28T12:21:36.2256601+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-28T12:21:36.2256601+00:00"
},
"job_status_id": "daaa8175-6b76-49b5-90c5-bf34c74bec6e",
"job_status_code": "sample string 11",
"db_address_id": "08cbb563-7499-49f4-9489-da243a07d0aa",
"contact_id": "b97a1e83-3f0c-4814-a2b1-26eda9a36273",
"requested_by_company_id": "cb0297d4-bbae-471f-b50f-752558bd0573",
"requested_by_contact_id": "7aba6621-4570-4093-9bad-8627c053fe70",
"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-28T12:21:36.2256601+00:00",
"due_date": "2026-07-28T12:21:36.2256601+00:00",
"date_create": "2026-07-28T12:21:36.2256601+00:00",
"date_update": "2026-07-28T12:21:36.2256601+00:00",
"date_closed": "2026-07-28T12:21:36.2256601+00:00",
"suggested_user_id": "36e8e942-098e-4fa5-9d6c-699ee7768060",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c7a76b31-b0dd-4dea-878b-d45ef74fdc9d",
"db_language_id": "824306e2-8963-42af-875d-09d6a792f5a8",
"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-28T12:21:36.2256601+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6bee4787-6d9a-4c86-a8f4-04e824ad6c0c",
"sales_organization": {
"id": "32991c13-071d-4ecf-900a-e816ea9a0786",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00a8aacb-d9b2-4f58-822b-8c26f28890b4",
"db_currency_id": "9220518c-ca8b-4b1d-b0a0-04bea9e3b981",
"db_language_id": "d447fe96-e1b3-4d85-a0a2-08dd799a2a31",
"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-28T12:21:36.2256601+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "cad75a02-9b19-4d79-a94b-e35dd70c9349",
"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": "1dcbc258-7862-4244-b138-a787f08047c0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-28T12:21:36.2256601+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b18a8295-6d09-439d-97b4-a7032cb885e3"
},
"suggested_date_start": "2026-07-28T12:21:36.2256601+00:00",
"skill_id": "99e7c261-cc4c-47cd-9361-87b945c7fa44",
"skill_code": "sample string 32",
"skill": {
"id": "9dd5938a-7a51-46d1-b317-88a09ad4280d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5ff1bbb5-27f9-440b-a5f3-3e1f0b260945",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "32991c13-071d-4ecf-900a-e816ea9a0786",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00a8aacb-d9b2-4f58-822b-8c26f28890b4",
"db_currency_id": "9220518c-ca8b-4b1d-b0a0-04bea9e3b981",
"db_language_id": "d447fe96-e1b3-4d85-a0a2-08dd799a2a31",
"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-28T12:21:36.2256601+00:00"
},
"modified_dateutc": "2026-07-28T12:21:36.2256601+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2e2c9f96-a673-4755-abd7-79eec0b72563",
"date_reported_by_company": "2026-07-28T12:21:36.2256601+00:00",
"id2": 36,
"company_id": "e8ed2551-3685-425d-a32a-515cd98af1e5",
"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": "8e540087-33eb-4356-b5a4-412391cfd474",
"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-28T12:21:36.2256601+00:00"
},
"work_instruction_details_id": "42788fec-4e02-4e39-b43d-66b090565a4c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e93175bd-51f8-421f-929d-6f145478011a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "fd8c3e96-2bf3-4069-8620-ccef4f3aeb97",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-28T12:21:36.2256601+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": "d5fc9b25-544a-4cab-8a8b-24d48d638bcf",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-28T12:21:36.2256601+00:00"
}