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": "b8101da8-0813-41d7-9020-77aafa7cc732",
"jobs_id": "2918a780-09bf-4f13-a0bc-bc2ee03da4f7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9d846cee-10cf-473e-b844-fe2522a93e6a",
"_parent_id": "42f55878-fa60-449d-b2a0-18753eb993ce",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "000832ef-d992-469d-a3c4-2684dba0d965",
"project_reference_back_office": "sample string 5",
"project": {
"id": "12ab0158-12e4-49a9-a0ef-4584e5e6997b",
"_parent_id": "393a8dfc-4616-40a6-a5a8-91b52759504f",
"root_parent_id": "45dbc84f-97b1-4eae-a068-3fe0b4d1d6e9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ad2c79d4-aa53-47ce-b1ff-d712a76acc6c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ba15b288-06a4-45fc-b828-1bc6ac944b63",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ad106aaf-a8b0-43de-a80f-3955726c1bbd",
"_parent_code": "sample string 6",
"sales_organization_id": "46c9a370-39b1-4ee0-9cb0-5ce353f3fbec",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6aeb8907-d727-40e6-a7a4-391c16f156b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7f9ad4fb-e94f-47b5-88d9-f9b451a64dc0",
"db_currency_id": "7217e6a4-b661-4afc-9b4d-4a761d1f1369",
"db_language_id": "0bdcfa8a-c9ba-4099-b21f-5c9734cbb92e",
"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": "2025-11-24T17:26:09.4933606+00:00"
},
"modified_dateutc": "2025-11-24T17:26:09.4933606+00:00"
},
"equipment_model_id": "ebe7a357-f5cf-4881-a8c8-9510a81e0250",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2d3065df-2610-4539-896d-c74b124c7561",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "515a037d-3c65-45e0-b79d-4a5b8bf48a3e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b3918892-fb08-4f2b-a33e-4740f3327a5c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4ff0c5aa-ee38-4bbf-b98a-802af42cb5dd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6aeb8907-d727-40e6-a7a4-391c16f156b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7f9ad4fb-e94f-47b5-88d9-f9b451a64dc0",
"db_currency_id": "7217e6a4-b661-4afc-9b4d-4a761d1f1369",
"db_language_id": "0bdcfa8a-c9ba-4099-b21f-5c9734cbb92e",
"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": "2025-11-24T17:26:09.4933606+00:00"
},
"modified_dateutc": "2025-11-24T17:26:09.4933606+00:00"
},
"equipment_family_id": "67c00f84-8c03-4d9c-8f91-aae3784f8bd6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ba15b288-06a4-45fc-b828-1bc6ac944b63",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ad106aaf-a8b0-43de-a80f-3955726c1bbd",
"_parent_code": "sample string 6",
"sales_organization_id": "46c9a370-39b1-4ee0-9cb0-5ce353f3fbec",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6aeb8907-d727-40e6-a7a4-391c16f156b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7f9ad4fb-e94f-47b5-88d9-f9b451a64dc0",
"db_currency_id": "7217e6a4-b661-4afc-9b4d-4a761d1f1369",
"db_language_id": "0bdcfa8a-c9ba-4099-b21f-5c9734cbb92e",
"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": "2025-11-24T17:26:09.4933606+00:00"
},
"modified_dateutc": "2025-11-24T17:26:09.4933606+00:00"
},
"date_in_production_since": "2025-11-24T17:26:09.4933606+00:00",
"date_out_of_production_since": "2025-11-24T17:26:09.4933606+00:00",
"date_end_support": "2025-11-24T17:26:09.4933606+00:00",
"sales_organization_id": "844217a8-a46e-4f2f-a663-3424726e8d68",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6aeb8907-d727-40e6-a7a4-391c16f156b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7f9ad4fb-e94f-47b5-88d9-f9b451a64dc0",
"db_currency_id": "7217e6a4-b661-4afc-9b4d-4a761d1f1369",
"db_language_id": "0bdcfa8a-c9ba-4099-b21f-5c9734cbb92e",
"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": "2025-11-24T17:26:09.4933606+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": "2025-11-24T17:26:09.4933606+00:00"
},
"project_status_id": "1243eedd-ab71-4f74-8c26-baaf742ae971",
"project_status_code": "sample string 10",
"project_status": {
"id": "d1308acc-19f8-41a6-a250-0d964d4f73dd",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "577feeeb-9158-4883-b073-ab0bfa291101",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6aeb8907-d727-40e6-a7a4-391c16f156b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7f9ad4fb-e94f-47b5-88d9-f9b451a64dc0",
"db_currency_id": "7217e6a4-b661-4afc-9b4d-4a761d1f1369",
"db_language_id": "0bdcfa8a-c9ba-4099-b21f-5c9734cbb92e",
"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": "2025-11-24T17:26:09.4933606+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-24T17:26:09.4933606+00:00"
},
"company_id": "cda87de2-e0b0-4b4a-acee-32ad2f28fd32",
"company_code": "sample string 12",
"db_address_id": "e1abf838-71d0-4a4d-a453-b9f0ca647e8f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9a468766-f2cb-4984-b312-d3b05db84f78",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "848a3705-b726-4dfa-899f-1e326199eb1e",
"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": "2025-11-24T17:26:09.4933606+00:00",
"date_create": "2025-11-24T17:26:09.4933606+00:00",
"date_update": "2025-11-24T17:26:09.4933606+00:00",
"updated_by_user_id": "57356e25-0c6c-4a1e-8cf4-b44e16c21cd5",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-24T17:26:09.4933606+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": "2025-11-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-24T17:26:09.4933606+00:00",
"date_last_job": "2025-11-24T17:26:09.4933606+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-24T17:26:09.4933606+00:00",
"modified_dateutc": "2025-11-24T17:26:09.4933606+00:00",
"is_mobile_installation": true
},
"job_type_id": "9806b17d-a4a7-4a04-9786-74992d56326b",
"job_type_code": "sample string 7",
"job_type": {
"id": "f43d5ad0-0a4e-47c4-8022-87f2510ff49b",
"name": "sample string 2",
"sales_organization_id": "cefcd2a4-c2df-42e8-85f1-8e67cdf768f5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-24T17:26:09.4933606+00:00",
"code": "sample string 7"
},
"job_priority_id": "fb572053-e7d0-4f55-bf49-7e524c10b125",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2d3d7da9-638c-4e21-a677-7231c9d4c816",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a9b04e11-70f8-4723-9f7f-800075f68068",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6aeb8907-d727-40e6-a7a4-391c16f156b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7f9ad4fb-e94f-47b5-88d9-f9b451a64dc0",
"db_currency_id": "7217e6a4-b661-4afc-9b4d-4a761d1f1369",
"db_language_id": "0bdcfa8a-c9ba-4099-b21f-5c9734cbb92e",
"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": "2025-11-24T17:26:09.4933606+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-24T17:26:09.4933606+00:00"
},
"job_status_id": "f81c4f56-b368-44d0-8f04-886e8c5aca6e",
"job_status_code": "sample string 11",
"db_address_id": "1df4b959-7059-4036-bd32-7919998abff3",
"contact_id": "3329b8cc-563e-4bd6-bbaf-5a8badc99ac1",
"requested_by_company_id": "75bc5e5c-24e8-4a54-9e3e-742e45843fed",
"requested_by_contact_id": "79f8e489-77b7-4e69-87ce-50f733df9911",
"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": "2025-11-24T17:26:09.4933606+00:00",
"due_date": "2025-11-24T17:26:09.4933606+00:00",
"date_create": "2025-11-24T17:26:09.4933606+00:00",
"date_update": "2025-11-24T17:26:09.4933606+00:00",
"date_closed": "2025-11-24T17:26:09.4933606+00:00",
"suggested_user_id": "01cd1cd9-52f1-4df8-bfeb-bc91d730fbb1",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "aee7462a-0437-4be6-8e1d-505976a1f147",
"db_language_id": "f5014b7b-10af-440e-9dde-c1f99a0301f9",
"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": "2025-11-24T17:26:09.4933606+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b6a09202-dc7f-48d9-ac2a-31cf59f0dd3e",
"sales_organization": {
"id": "6aeb8907-d727-40e6-a7a4-391c16f156b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7f9ad4fb-e94f-47b5-88d9-f9b451a64dc0",
"db_currency_id": "7217e6a4-b661-4afc-9b4d-4a761d1f1369",
"db_language_id": "0bdcfa8a-c9ba-4099-b21f-5c9734cbb92e",
"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": "2025-11-24T17:26:09.4933606+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "fc85bbb8-f6b7-4a2e-a30c-637d0d8b69f3",
"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": "81a58807-0ee4-437a-9a33-d697bbfef30a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-24T17:26:09.4933606+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "63e4c3c7-2c87-4558-b5d1-87d1b321db3a"
},
"suggested_date_start": "2025-11-24T17:26:09.4933606+00:00",
"skill_id": "ebe5435b-3da0-4c8b-abc3-ffe2d7cad94b",
"skill_code": "sample string 32",
"skill": {
"id": "ded26dfc-e9d8-480a-a9d6-a22711b42052",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "10c01eed-ff50-4308-8249-b44369a94d39",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6aeb8907-d727-40e6-a7a4-391c16f156b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7f9ad4fb-e94f-47b5-88d9-f9b451a64dc0",
"db_currency_id": "7217e6a4-b661-4afc-9b4d-4a761d1f1369",
"db_language_id": "0bdcfa8a-c9ba-4099-b21f-5c9734cbb92e",
"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": "2025-11-24T17:26:09.4933606+00:00"
},
"modified_dateutc": "2025-11-24T17:26:09.4933606+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b0f39ee9-efc1-47c3-9dab-4161d83a841a",
"date_reported_by_company": "2025-11-24T17:26:09.4933606+00:00",
"id2": 36,
"company_id": "82fe7b66-4275-45bf-a826-adbb7d16268b",
"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": "ed551a4b-7607-4d8d-92d2-b74d2cc263fe",
"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": "2025-11-24T17:26:09.4933606+00:00"
},
"work_instruction_details_id": "19972b9a-7588-46a0-aefc-4634dae41968",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b6bf005e-db02-4b26-af3c-d3cea9b27b5a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2317261d-be80-4a59-8414-ca5e6102f2b3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-24T17:26:09.4933606+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": "78c7c6c5-c7c3-47fa-8e10-c80acffa3081",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-24T17:26:09.4933606+00:00"
}