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": "57bb54d6-9ee6-4370-92b0-ef01afe10682",
"jobs_id": "e686c1ab-7f7f-4264-8b07-8c5b3f9a4714",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "afe9c514-be74-4282-abf5-e0e9be840320",
"_parent_id": "f650b0a9-cf1f-4ddb-9b5c-367a5421c048",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1e79f1a9-9559-4d0f-870d-522254b3bb32",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e66cc6c9-a6f9-46fc-bc5f-fe74f8a5c366",
"_parent_id": "47730af6-3403-4bff-945c-c17a8d81ce0e",
"root_parent_id": "ad7f6f16-0fe8-4b12-ac1f-f0f82c3082e4",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b3e96f39-5304-4272-ac18-935ce0d3cdfd",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ad04e522-9049-4b5e-9b0c-479ab70fd99d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "21546d53-724b-470d-bf4d-f7ac7c892c7b",
"_parent_code": "sample string 6",
"sales_organization_id": "28154974-4990-4989-9b23-275ed1468b2b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "651850f4-548e-4343-87cb-a564f15a0df3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de037a35-e04b-45b3-b598-630b761f4858",
"db_currency_id": "b5c2e89a-5ba4-4f18-985e-64a105ebe68b",
"db_language_id": "2447decd-880b-47f4-95e5-5ba9fba13016",
"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-16T05:24:12.6026649+00:00"
},
"modified_dateutc": "2026-04-16T05:24:12.6026649+00:00"
},
"equipment_model_id": "a44f9df9-d9df-4297-bc39-d87ae0df2a9a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e1873cff-1485-4da7-84e5-2a8203ae05d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "de638645-b69d-405a-89ad-fb19651325b0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5eab5d9d-b548-4926-a4f8-1fd6a4a4079a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "734e8926-1a47-4494-8a8f-6d9ae2f38a1d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "651850f4-548e-4343-87cb-a564f15a0df3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de037a35-e04b-45b3-b598-630b761f4858",
"db_currency_id": "b5c2e89a-5ba4-4f18-985e-64a105ebe68b",
"db_language_id": "2447decd-880b-47f4-95e5-5ba9fba13016",
"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-16T05:24:12.6026649+00:00"
},
"modified_dateutc": "2026-04-16T05:24:12.6026649+00:00"
},
"equipment_family_id": "48e07ea9-30ad-4b55-a513-a59f597f180a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ad04e522-9049-4b5e-9b0c-479ab70fd99d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "21546d53-724b-470d-bf4d-f7ac7c892c7b",
"_parent_code": "sample string 6",
"sales_organization_id": "28154974-4990-4989-9b23-275ed1468b2b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "651850f4-548e-4343-87cb-a564f15a0df3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de037a35-e04b-45b3-b598-630b761f4858",
"db_currency_id": "b5c2e89a-5ba4-4f18-985e-64a105ebe68b",
"db_language_id": "2447decd-880b-47f4-95e5-5ba9fba13016",
"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-16T05:24:12.6026649+00:00"
},
"modified_dateutc": "2026-04-16T05:24:12.6026649+00:00"
},
"date_in_production_since": "2026-04-16T05:24:12.6026649+00:00",
"date_out_of_production_since": "2026-04-16T05:24:12.6026649+00:00",
"date_end_support": "2026-04-16T05:24:12.6026649+00:00",
"sales_organization_id": "6aea361a-6261-48ec-b674-9d50aeb2075e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "651850f4-548e-4343-87cb-a564f15a0df3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de037a35-e04b-45b3-b598-630b761f4858",
"db_currency_id": "b5c2e89a-5ba4-4f18-985e-64a105ebe68b",
"db_language_id": "2447decd-880b-47f4-95e5-5ba9fba13016",
"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-16T05:24:12.6026649+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-16T05:24:12.6026649+00:00"
},
"project_status_id": "0b59de5d-42b0-4fbd-8fb6-9cb7402596d5",
"project_status_code": "sample string 10",
"project_status": {
"id": "2024f8f1-eb94-495d-91da-f1edc5b446a6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "58f31101-a39b-45cb-9f99-9b1e0054a146",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "651850f4-548e-4343-87cb-a564f15a0df3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de037a35-e04b-45b3-b598-630b761f4858",
"db_currency_id": "b5c2e89a-5ba4-4f18-985e-64a105ebe68b",
"db_language_id": "2447decd-880b-47f4-95e5-5ba9fba13016",
"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-16T05:24:12.6026649+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-16T05:24:12.6026649+00:00"
},
"company_id": "cb107284-a69d-462d-b405-b2c28c549d54",
"company_code": "sample string 12",
"db_address_id": "75b8cca4-12af-4f29-b3b9-1a65e12b00ac",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8a9061f5-90e2-4414-92fc-6720300b8499",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6be2c26a-8d8d-4811-bfaa-174d38716b66",
"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-16T05:24:12.6026649+00:00",
"date_create": "2026-04-16T05:24:12.6026649+00:00",
"date_update": "2026-04-16T05:24:12.6026649+00:00",
"updated_by_user_id": "6baf2170-dbfd-4356-add0-96b218ac0dc0",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-16T05:24:12.6026649+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-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-16T05:24:12.6026649+00:00",
"date_last_job": "2026-04-16T05:24:12.6026649+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-16T05:24:12.6026649+00:00",
"modified_dateutc": "2026-04-16T05:24:12.6026649+00:00",
"is_mobile_installation": true
},
"job_type_id": "003a4870-423b-4c3f-bc11-6cd994e2a567",
"job_type_code": "sample string 7",
"job_type": {
"id": "342bde73-8899-4209-87de-74f997399ec9",
"name": "sample string 2",
"sales_organization_id": "cb7dbaab-9a3b-4203-a26b-65d2445cb204",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-16T05:24:12.6026649+00:00",
"code": "sample string 7"
},
"job_priority_id": "9a98c7e7-8467-407d-93f1-aa7e4b137408",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c14ed618-0267-44af-9bea-d280e04abb81",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7be55a49-6876-4fb9-9ae4-bdf8b23d1728",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "651850f4-548e-4343-87cb-a564f15a0df3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de037a35-e04b-45b3-b598-630b761f4858",
"db_currency_id": "b5c2e89a-5ba4-4f18-985e-64a105ebe68b",
"db_language_id": "2447decd-880b-47f4-95e5-5ba9fba13016",
"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-16T05:24:12.6026649+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-16T05:24:12.6026649+00:00"
},
"job_status_id": "07c74927-2a12-4487-8839-13fefc2bced8",
"job_status_code": "sample string 11",
"db_address_id": "6c717c0d-4e00-4ff4-ac52-911ffbb72c71",
"contact_id": "6bfaa60a-4923-4f45-b547-980baa0e56da",
"requested_by_company_id": "a5888ef9-cafa-4636-84a4-d8452fd9c0e3",
"requested_by_contact_id": "ec19e46a-a67c-4222-954d-7bf6e2ef6d1c",
"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-16T05:24:12.6182875+00:00",
"due_date": "2026-04-16T05:24:12.6182875+00:00",
"date_create": "2026-04-16T05:24:12.6182875+00:00",
"date_update": "2026-04-16T05:24:12.6182875+00:00",
"date_closed": "2026-04-16T05:24:12.6182875+00:00",
"suggested_user_id": "3de4940d-44f4-4f72-89cf-6ca30bd7aadb",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "01c6b6f1-fb19-47a5-876f-e2f46c8cc1f6",
"db_language_id": "84400b0b-5851-4f9a-bc33-a6df1391855a",
"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-16T05:24:12.6182875+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "115450c3-ad01-4eb9-beae-d460333421f4",
"sales_organization": {
"id": "651850f4-548e-4343-87cb-a564f15a0df3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de037a35-e04b-45b3-b598-630b761f4858",
"db_currency_id": "b5c2e89a-5ba4-4f18-985e-64a105ebe68b",
"db_language_id": "2447decd-880b-47f4-95e5-5ba9fba13016",
"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-16T05:24:12.6026649+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f7c855d6-c0c2-4d49-b01a-d3876a93e518",
"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": "e403a385-44b4-472b-9f4a-f6323a9f1f8c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-16T05:24:12.6182875+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "92d9d747-7fb7-4bec-a0b1-9af4ec16609d"
},
"suggested_date_start": "2026-04-16T05:24:12.6182875+00:00",
"skill_id": "4eb12ba9-23a7-4c19-abd1-28ced855a28e",
"skill_code": "sample string 32",
"skill": {
"id": "9b9f5778-ee12-4685-b5cf-00b2535be011",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "24c6e373-1c09-422b-a6d4-b1cb3b1c62b9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "651850f4-548e-4343-87cb-a564f15a0df3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de037a35-e04b-45b3-b598-630b761f4858",
"db_currency_id": "b5c2e89a-5ba4-4f18-985e-64a105ebe68b",
"db_language_id": "2447decd-880b-47f4-95e5-5ba9fba13016",
"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-16T05:24:12.6026649+00:00"
},
"modified_dateutc": "2026-04-16T05:24:12.6182875+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2c884c6b-519d-4d13-ba7a-ca9c72f37919",
"date_reported_by_company": "2026-04-16T05:24:12.6182875+00:00",
"id2": 36,
"company_id": "109b5f8a-935d-47f5-9182-e99e360d3d9d",
"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": "71f9d942-0bf4-44e4-8f30-2d9d11c2071a",
"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-16T05:24:12.6182875+00:00"
},
"work_instruction_details_id": "6f29a890-2189-42a8-823e-a1dccdc9e19d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c57eea94-a2fb-499c-baa9-0cc88808fe70",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e64352ce-e25b-4550-8626-d3abb5b73c17",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-16T05:24:12.6182875+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": "1533e58a-c524-42d1-8f93-04e28285d971",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-16T05:24:12.6182875+00:00"
}