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": "e542d57b-53ed-40a7-ac3c-2897003835cc",
"jobs_id": "a6519997-3cfa-40d6-9c1c-674476e720b5",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e700659c-4e6d-4776-b972-1b9e509ecbe5",
"_parent_id": "25565797-d3c0-47a4-8f97-72fee25f9909",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "eaf4fc3a-bc31-4a26-a0ad-d5f786ef7ab3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "cb0dfa55-60c1-49e4-ba3e-0a9462982494",
"_parent_id": "8df374dc-23d2-4e52-8f83-3ce3288a791e",
"root_parent_id": "30245728-2e68-4548-8762-8f7eb2681433",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ec2199fe-8e2b-4e88-936d-f7238a1f5f65",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2a2e1d46-d8cd-47da-a987-cf69ebd89407",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "86a2168a-66de-4e92-b3a2-5702c34db239",
"_parent_code": "sample string 6",
"sales_organization_id": "ea5440f1-6c7d-44c1-9c2f-ab52532807db",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6fcbe96f-9d03-42f8-ba70-d6d845bd19c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78b58867-f197-48c0-b2dd-b232c355cf20",
"db_currency_id": "ca307660-3fd4-4567-8d0d-1fa8ee7d9611",
"db_language_id": "ee03fde3-ae2a-43c4-a216-56ff17417634",
"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-24T11:01:42.5191375+00:00"
},
"modified_dateutc": "2026-04-24T11:01:42.5191375+00:00"
},
"equipment_model_id": "1c15d16d-5557-4f33-8c34-81f60125495a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8d8a8655-58e3-492a-8c4e-628e01a10e8b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2776efc7-f644-470e-808e-5bf5dae079bd",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "27684b71-7644-439d-8060-cf21c6f55667",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "790535b4-ede6-4f80-97c5-1d5267d85a69",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6fcbe96f-9d03-42f8-ba70-d6d845bd19c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78b58867-f197-48c0-b2dd-b232c355cf20",
"db_currency_id": "ca307660-3fd4-4567-8d0d-1fa8ee7d9611",
"db_language_id": "ee03fde3-ae2a-43c4-a216-56ff17417634",
"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-24T11:01:42.5191375+00:00"
},
"modified_dateutc": "2026-04-24T11:01:42.5191375+00:00"
},
"equipment_family_id": "f2abb1a4-dce9-4f96-9ece-dc8f4d4debab",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2a2e1d46-d8cd-47da-a987-cf69ebd89407",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "86a2168a-66de-4e92-b3a2-5702c34db239",
"_parent_code": "sample string 6",
"sales_organization_id": "ea5440f1-6c7d-44c1-9c2f-ab52532807db",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6fcbe96f-9d03-42f8-ba70-d6d845bd19c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78b58867-f197-48c0-b2dd-b232c355cf20",
"db_currency_id": "ca307660-3fd4-4567-8d0d-1fa8ee7d9611",
"db_language_id": "ee03fde3-ae2a-43c4-a216-56ff17417634",
"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-24T11:01:42.5191375+00:00"
},
"modified_dateutc": "2026-04-24T11:01:42.5191375+00:00"
},
"date_in_production_since": "2026-04-24T11:01:42.5191375+00:00",
"date_out_of_production_since": "2026-04-24T11:01:42.5191375+00:00",
"date_end_support": "2026-04-24T11:01:42.5191375+00:00",
"sales_organization_id": "ab5a8f84-ec2c-4a99-9948-bed24cee18ef",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6fcbe96f-9d03-42f8-ba70-d6d845bd19c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78b58867-f197-48c0-b2dd-b232c355cf20",
"db_currency_id": "ca307660-3fd4-4567-8d0d-1fa8ee7d9611",
"db_language_id": "ee03fde3-ae2a-43c4-a216-56ff17417634",
"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-24T11:01:42.5191375+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-24T11:01:42.5191375+00:00"
},
"project_status_id": "0706b180-affa-49e8-9a5e-e7ab49155050",
"project_status_code": "sample string 10",
"project_status": {
"id": "2b78939c-74de-49f6-a876-ea1330c28332",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5c8e7dc5-8f5f-49cd-a139-528e5d578a66",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6fcbe96f-9d03-42f8-ba70-d6d845bd19c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78b58867-f197-48c0-b2dd-b232c355cf20",
"db_currency_id": "ca307660-3fd4-4567-8d0d-1fa8ee7d9611",
"db_language_id": "ee03fde3-ae2a-43c4-a216-56ff17417634",
"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-24T11:01:42.5191375+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-24T11:01:42.5191375+00:00"
},
"company_id": "81ce4a12-dbed-47eb-8958-fd412e1226c7",
"company_code": "sample string 12",
"db_address_id": "5054b520-67ac-442a-b0ab-7c0f5816e4bd",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "16179ff7-2cea-494f-9849-cf04da1e45ed",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b5bbbe8b-984e-4d8f-a6cf-b6bd03894470",
"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-24T11:01:42.5191375+00:00",
"date_create": "2026-04-24T11:01:42.5191375+00:00",
"date_update": "2026-04-24T11:01:42.5191375+00:00",
"updated_by_user_id": "2c9066e9-6e8a-427a-a6dd-2e8724a9fd08",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-24T11:01:42.5191375+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-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-24T11:01:42.5191375+00:00",
"date_last_job": "2026-04-24T11:01:42.5191375+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-24T11:01:42.5191375+00:00",
"modified_dateutc": "2026-04-24T11:01:42.5191375+00:00",
"is_mobile_installation": true
},
"job_type_id": "3f08eec2-6614-4768-83c5-25fe345e1a56",
"job_type_code": "sample string 7",
"job_type": {
"id": "f3878a52-0a41-4b37-9ee2-dcfb49f65ee3",
"name": "sample string 2",
"sales_organization_id": "33955027-f7c0-48ba-b4a0-ab21d1f88b90",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-24T11:01:42.5347634+00:00",
"code": "sample string 7"
},
"job_priority_id": "088c6e9e-ab55-4507-8c35-223757e50dc9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "bd1625d4-eb57-4ff0-a2d6-e7a9b9658e06",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "51a0dcd3-80e5-4101-af1c-6677c19259fe",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6fcbe96f-9d03-42f8-ba70-d6d845bd19c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78b58867-f197-48c0-b2dd-b232c355cf20",
"db_currency_id": "ca307660-3fd4-4567-8d0d-1fa8ee7d9611",
"db_language_id": "ee03fde3-ae2a-43c4-a216-56ff17417634",
"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-24T11:01:42.5191375+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-24T11:01:42.5347634+00:00"
},
"job_status_id": "7f302984-f056-495d-a6a2-bc1277beade0",
"job_status_code": "sample string 11",
"db_address_id": "220444f1-321e-409f-827d-5e33d4bc79c4",
"contact_id": "02a6c6be-5744-437a-9a7a-76a29c60646f",
"requested_by_company_id": "fa048d8e-60db-4487-9bb7-7c30fa956c1e",
"requested_by_contact_id": "5a19569b-1184-4623-bd5b-4b89ba86e56b",
"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-24T11:01:42.5347634+00:00",
"due_date": "2026-04-24T11:01:42.5347634+00:00",
"date_create": "2026-04-24T11:01:42.5347634+00:00",
"date_update": "2026-04-24T11:01:42.5347634+00:00",
"date_closed": "2026-04-24T11:01:42.5347634+00:00",
"suggested_user_id": "bdf715fb-e0c5-47c7-85ba-1f5756869409",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "40fd2478-5cc2-41fa-bdce-d28cea115cf2",
"db_language_id": "1ff02524-3fd7-4443-8e2a-b669b7093c01",
"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-24T11:01:42.5347634+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f36210dd-3136-4940-a732-74dbda1f72c3",
"sales_organization": {
"id": "6fcbe96f-9d03-42f8-ba70-d6d845bd19c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78b58867-f197-48c0-b2dd-b232c355cf20",
"db_currency_id": "ca307660-3fd4-4567-8d0d-1fa8ee7d9611",
"db_language_id": "ee03fde3-ae2a-43c4-a216-56ff17417634",
"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-24T11:01:42.5191375+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "abd3830a-7ee4-4475-8669-dfe956f101be",
"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": "56ab5e39-b9bc-44b0-9ef3-73e5ab7f84a0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-24T11:01:42.5347634+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "41e19ccb-eec2-4a21-93bc-bfa2ac2ed157"
},
"suggested_date_start": "2026-04-24T11:01:42.5347634+00:00",
"skill_id": "2e447569-56aa-45e7-86d7-95f0bf98eb03",
"skill_code": "sample string 32",
"skill": {
"id": "1892b1ea-b4c6-419e-9ab2-e3dbb28cc14f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ead6b7a8-f999-4c3e-ad22-a570fb27b797",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6fcbe96f-9d03-42f8-ba70-d6d845bd19c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78b58867-f197-48c0-b2dd-b232c355cf20",
"db_currency_id": "ca307660-3fd4-4567-8d0d-1fa8ee7d9611",
"db_language_id": "ee03fde3-ae2a-43c4-a216-56ff17417634",
"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-24T11:01:42.5191375+00:00"
},
"modified_dateutc": "2026-04-24T11:01:42.5347634+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "61fe0445-2a7f-4ef8-8f61-037c3dd72a6d",
"date_reported_by_company": "2026-04-24T11:01:42.5347634+00:00",
"id2": 36,
"company_id": "21508877-51f5-4096-8b49-8aededea6078",
"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": "1d1b0bd2-1a42-4d6d-ae43-23e8ca22dea4",
"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-24T11:01:42.5347634+00:00"
},
"work_instruction_details_id": "19c215e9-bb75-4d66-b494-9e864de9be30",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6ecaaeea-6b2e-4939-a350-46200e897f9b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5360bd21-457b-41a1-8e3c-adca3436065b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-24T11:01:42.5347634+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": "b9178b76-5b4d-4350-a966-c6bd57e527cc",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-24T11:01:42.5347634+00:00"
}