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": "e6a8ef3c-a043-4752-9a9e-e5a3a4a7f867",
"jobs_id": "d06a9b9e-dbe9-45d0-9410-daef7d75329f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "05ac97d8-d7f6-4966-82e4-b1046aa601cc",
"_parent_id": "f25b334c-890b-4c94-ba30-7e4c2a2f4fa0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e0df63ef-91d3-4df7-94c6-307872d39bd2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "11cbab56-82d2-47d8-bae9-50ef9f8553dd",
"_parent_id": "e79371c9-1ec5-48bc-8033-6d5508a64d6f",
"root_parent_id": "44f869f1-0d14-47a4-85f1-a9d0e9c2e957",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ca25562e-55c4-4270-b2fa-c3e8ecd46f52",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c3586148-924c-4472-9b17-c86916f48f0a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "62c74bde-116c-4cea-abed-2c1a56eb7aff",
"_parent_code": "sample string 6",
"sales_organization_id": "dfc516d4-5f14-44f9-a755-a7ff3a45c8dd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4a395c78-2a3f-418f-8571-802d3a4fbc0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c49b398f-c8ef-450e-955c-844ee11c0db7",
"db_currency_id": "56e1ab30-716d-41b4-8e41-91b9fa623858",
"db_language_id": "941b9c62-6404-465b-907a-8d932b43246c",
"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-21T23:12:30.1583567+00:00"
},
"modified_dateutc": "2026-04-21T23:12:30.1583567+00:00"
},
"equipment_model_id": "d74ded51-877c-4605-9290-c21171991df4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3ffab1f3-8b51-4965-9429-42295cd5851a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5a29b66a-cfdf-4ac3-8e73-1cd8a4eb40bc",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e5dd915b-ffef-4f17-b6eb-63df4fa2087f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c38d6f7d-c6e7-446d-bdf7-dc89457f7982",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4a395c78-2a3f-418f-8571-802d3a4fbc0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c49b398f-c8ef-450e-955c-844ee11c0db7",
"db_currency_id": "56e1ab30-716d-41b4-8e41-91b9fa623858",
"db_language_id": "941b9c62-6404-465b-907a-8d932b43246c",
"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-21T23:12:30.1583567+00:00"
},
"modified_dateutc": "2026-04-21T23:12:30.1583567+00:00"
},
"equipment_family_id": "24c91202-0b0c-410a-9682-4940400e43ed",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c3586148-924c-4472-9b17-c86916f48f0a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "62c74bde-116c-4cea-abed-2c1a56eb7aff",
"_parent_code": "sample string 6",
"sales_organization_id": "dfc516d4-5f14-44f9-a755-a7ff3a45c8dd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4a395c78-2a3f-418f-8571-802d3a4fbc0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c49b398f-c8ef-450e-955c-844ee11c0db7",
"db_currency_id": "56e1ab30-716d-41b4-8e41-91b9fa623858",
"db_language_id": "941b9c62-6404-465b-907a-8d932b43246c",
"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-21T23:12:30.1583567+00:00"
},
"modified_dateutc": "2026-04-21T23:12:30.1583567+00:00"
},
"date_in_production_since": "2026-04-21T23:12:30.1583567+00:00",
"date_out_of_production_since": "2026-04-21T23:12:30.1583567+00:00",
"date_end_support": "2026-04-21T23:12:30.1583567+00:00",
"sales_organization_id": "daba6a38-96a2-497c-8477-4e24fedd833e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4a395c78-2a3f-418f-8571-802d3a4fbc0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c49b398f-c8ef-450e-955c-844ee11c0db7",
"db_currency_id": "56e1ab30-716d-41b4-8e41-91b9fa623858",
"db_language_id": "941b9c62-6404-465b-907a-8d932b43246c",
"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-21T23:12:30.1583567+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-21T23:12:30.1583567+00:00"
},
"project_status_id": "ba343c1a-e609-4def-b96e-913a4c901654",
"project_status_code": "sample string 10",
"project_status": {
"id": "68b5445c-0f81-4620-9107-d0b20409c251",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b2e3deed-c43f-4941-b0d5-5831d3cd64b7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4a395c78-2a3f-418f-8571-802d3a4fbc0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c49b398f-c8ef-450e-955c-844ee11c0db7",
"db_currency_id": "56e1ab30-716d-41b4-8e41-91b9fa623858",
"db_language_id": "941b9c62-6404-465b-907a-8d932b43246c",
"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-21T23:12:30.1583567+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-21T23:12:30.1583567+00:00"
},
"company_id": "777b21b3-a45c-4157-95dd-b2294c40a7a8",
"company_code": "sample string 12",
"db_address_id": "52b3ee00-f292-4f78-8989-1f948cdf06a0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ee10ddc5-23a3-48fe-8fdd-890357eabae7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4aa40304-6441-43ab-97df-20fcf31436c9",
"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-21T23:12:30.1583567+00:00",
"date_create": "2026-04-21T23:12:30.1583567+00:00",
"date_update": "2026-04-21T23:12:30.1583567+00:00",
"updated_by_user_id": "a7368058-177f-4347-82c5-b6fa721d3c75",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-21T23:12:30.1583567+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-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-21T23:12:30.1583567+00:00",
"date_last_job": "2026-04-21T23:12:30.1583567+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-21T23:12:30.1583567+00:00",
"modified_dateutc": "2026-04-21T23:12:30.1583567+00:00",
"is_mobile_installation": true
},
"job_type_id": "3c214fe4-6f56-40d1-8190-e698f253d6e1",
"job_type_code": "sample string 7",
"job_type": {
"id": "cdde2671-fc8b-4227-9c2c-63724e8d4c2c",
"name": "sample string 2",
"sales_organization_id": "e12d630a-71b2-4865-91f4-8263137bdaa6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-21T23:12:30.1583567+00:00",
"code": "sample string 7"
},
"job_priority_id": "ccedcbe5-c309-4659-a082-c042b9e1983d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e4e2e10e-ca15-4a6c-85f1-b85f0355f51b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e7362692-8241-4bbd-bbee-82f0ad0cf6b0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4a395c78-2a3f-418f-8571-802d3a4fbc0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c49b398f-c8ef-450e-955c-844ee11c0db7",
"db_currency_id": "56e1ab30-716d-41b4-8e41-91b9fa623858",
"db_language_id": "941b9c62-6404-465b-907a-8d932b43246c",
"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-21T23:12:30.1583567+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-21T23:12:30.1583567+00:00"
},
"job_status_id": "a500146a-274c-4476-8671-eaebc1748a54",
"job_status_code": "sample string 11",
"db_address_id": "6d42e6ab-480d-4465-9041-5eae2ae6e639",
"contact_id": "fe00234a-a172-4569-a286-1e98db3831c9",
"requested_by_company_id": "73c97cc7-e479-42ae-a768-57ccbb0b4dbf",
"requested_by_contact_id": "2f8df758-3890-43da-a550-2bd5b842188b",
"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-21T23:12:30.1583567+00:00",
"due_date": "2026-04-21T23:12:30.1583567+00:00",
"date_create": "2026-04-21T23:12:30.1583567+00:00",
"date_update": "2026-04-21T23:12:30.1583567+00:00",
"date_closed": "2026-04-21T23:12:30.1583567+00:00",
"suggested_user_id": "0283ca3c-869e-47a9-9035-bef064109d9e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "dbb365c7-63ff-4050-b5d6-2c9111aeaa92",
"db_language_id": "a8921df3-0f3e-4fb9-80e3-2a23ef6d91c3",
"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-21T23:12:30.1740098+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e510ba8b-9450-4bfa-9a43-50282293ca3a",
"sales_organization": {
"id": "4a395c78-2a3f-418f-8571-802d3a4fbc0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c49b398f-c8ef-450e-955c-844ee11c0db7",
"db_currency_id": "56e1ab30-716d-41b4-8e41-91b9fa623858",
"db_language_id": "941b9c62-6404-465b-907a-8d932b43246c",
"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-21T23:12:30.1583567+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c3252623-b504-4165-b309-68910bcb4952",
"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": "e6883ac0-b2cf-4bc6-816a-a3a5fecc22d0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-21T23:12:30.1740098+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0f694a4c-e96f-4b98-b8cf-bae66cc5dc5f"
},
"suggested_date_start": "2026-04-21T23:12:30.1740098+00:00",
"skill_id": "e14a0c16-34e8-4e9e-9477-42c2582d3f2f",
"skill_code": "sample string 32",
"skill": {
"id": "56c521df-3885-4c82-8a04-80a3a4c1f64e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e4b9aa25-76c9-42ab-b44c-58a21a0365a7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4a395c78-2a3f-418f-8571-802d3a4fbc0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c49b398f-c8ef-450e-955c-844ee11c0db7",
"db_currency_id": "56e1ab30-716d-41b4-8e41-91b9fa623858",
"db_language_id": "941b9c62-6404-465b-907a-8d932b43246c",
"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-21T23:12:30.1583567+00:00"
},
"modified_dateutc": "2026-04-21T23:12:30.1740098+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e89573eb-c949-4c10-9fa9-b088ba4bfe0c",
"date_reported_by_company": "2026-04-21T23:12:30.1740098+00:00",
"id2": 36,
"company_id": "e49abc2b-0a30-48f7-aec6-d17670a82299",
"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": "b4ca982b-21ba-45ff-826b-654f1ce5bd72",
"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-21T23:12:30.1740098+00:00"
},
"work_instruction_details_id": "5d92ae96-d272-4779-a1bd-d68733284434",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "30fcfa85-63ca-45e0-b9bd-96bc2768e0e7",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "fd0d52b2-a05e-4d27-a8c1-5a1a3626d161",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-21T23:12:30.1740098+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": "7143f08f-9e93-49fb-af0c-e61644a611b0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-21T23:12:30.1740098+00:00"
}