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": "f8f3a582-d960-4cb7-a0a3-d27d62b74035",
"jobs_id": "689eedbe-a822-4410-a477-b1b986451845",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9168e73c-5cb3-4a0e-a66d-159dc901e7ce",
"_parent_id": "5a6369fd-b7f9-411d-8353-98357e59b80d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "89e160ff-f5e4-4c54-9b57-7b77106e7011",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e84f5f2f-515d-4caa-8411-ef276f3f3369",
"_parent_id": "291d4fe6-6f02-4f87-9a4c-dcb7647e824d",
"root_parent_id": "bec96361-84d1-4698-a4e6-2f9abd1f8059",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2cd09313-8bbd-4fb3-b8b4-460e689a28f8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f672f82d-1ba6-4b9f-aadb-c32cc7941f61",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c8965cea-0150-4a15-9f5f-e08b025d44ef",
"_parent_code": "sample string 6",
"sales_organization_id": "6b4c2d1b-a9b7-4f0a-9379-2f062c0a1084",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d848df62-1474-4b47-90cf-d7ae4a282ba2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ad32c3e-0165-4acf-94d0-7a95098dc50d",
"db_currency_id": "542fef78-12dd-4b42-9d3e-2dbfd5dd3aff",
"db_language_id": "5e5166a7-be1f-40e0-90fd-f8d4f8aef9af",
"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-05-15T01:05:07.3685806+00:00"
},
"modified_dateutc": "2026-05-15T01:05:07.3685806+00:00"
},
"equipment_model_id": "75360437-be8c-44e3-85e1-0a6481071089",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "73f2c696-43a9-44b0-9dfe-12cb45914ecc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "abeb6c87-65ae-44da-a5d7-493896771b31",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7d1e98c2-ce5b-4540-8269-46487e012f5c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9084f0ac-72a8-462c-aa0a-0eb26833a849",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d848df62-1474-4b47-90cf-d7ae4a282ba2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ad32c3e-0165-4acf-94d0-7a95098dc50d",
"db_currency_id": "542fef78-12dd-4b42-9d3e-2dbfd5dd3aff",
"db_language_id": "5e5166a7-be1f-40e0-90fd-f8d4f8aef9af",
"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-05-15T01:05:07.3685806+00:00"
},
"modified_dateutc": "2026-05-15T01:05:07.3685806+00:00"
},
"equipment_family_id": "c614973c-5f49-4016-9d02-85902e8451bf",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f672f82d-1ba6-4b9f-aadb-c32cc7941f61",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c8965cea-0150-4a15-9f5f-e08b025d44ef",
"_parent_code": "sample string 6",
"sales_organization_id": "6b4c2d1b-a9b7-4f0a-9379-2f062c0a1084",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d848df62-1474-4b47-90cf-d7ae4a282ba2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ad32c3e-0165-4acf-94d0-7a95098dc50d",
"db_currency_id": "542fef78-12dd-4b42-9d3e-2dbfd5dd3aff",
"db_language_id": "5e5166a7-be1f-40e0-90fd-f8d4f8aef9af",
"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-05-15T01:05:07.3685806+00:00"
},
"modified_dateutc": "2026-05-15T01:05:07.3685806+00:00"
},
"date_in_production_since": "2026-05-15T01:05:07.3685806+00:00",
"date_out_of_production_since": "2026-05-15T01:05:07.3685806+00:00",
"date_end_support": "2026-05-15T01:05:07.3685806+00:00",
"sales_organization_id": "df50d56f-4124-4787-b44c-26e3a243ef84",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d848df62-1474-4b47-90cf-d7ae4a282ba2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ad32c3e-0165-4acf-94d0-7a95098dc50d",
"db_currency_id": "542fef78-12dd-4b42-9d3e-2dbfd5dd3aff",
"db_language_id": "5e5166a7-be1f-40e0-90fd-f8d4f8aef9af",
"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-05-15T01:05:07.3685806+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-05-15T01:05:07.3685806+00:00"
},
"project_status_id": "8e9c9b23-7f45-44c7-b0bb-625ad7672315",
"project_status_code": "sample string 10",
"project_status": {
"id": "2466a0dc-72aa-4090-9a23-7287a49d4fcc",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b2cde1b0-c51f-4b32-8fa3-b905d176e6f6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d848df62-1474-4b47-90cf-d7ae4a282ba2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ad32c3e-0165-4acf-94d0-7a95098dc50d",
"db_currency_id": "542fef78-12dd-4b42-9d3e-2dbfd5dd3aff",
"db_language_id": "5e5166a7-be1f-40e0-90fd-f8d4f8aef9af",
"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-05-15T01:05:07.3685806+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-15T01:05:07.3685806+00:00"
},
"company_id": "89c3e6f4-3452-4e41-b88d-1ed394808bcc",
"company_code": "sample string 12",
"db_address_id": "2a25d6dc-ebda-4395-8ae7-26f203e79e69",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3de14c57-8519-4a02-bb4a-95247dbb774a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b5481243-764c-4eea-99e1-e52a5d0d50cc",
"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-05-15T01:05:07.3685806+00:00",
"date_create": "2026-05-15T01:05:07.3685806+00:00",
"date_update": "2026-05-15T01:05:07.3685806+00:00",
"updated_by_user_id": "984bdc4b-df83-4269-9f38-e9976bc18909",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-15T01:05:07.3685806+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-05-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-15T01:05:07.3685806+00:00",
"date_last_job": "2026-05-15T01:05:07.3685806+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-15T01:05:07.3685806+00:00",
"modified_dateutc": "2026-05-15T01:05:07.3685806+00:00",
"is_mobile_installation": true
},
"job_type_id": "8baa1f8a-54d1-4a6e-b513-c3e9577e0576",
"job_type_code": "sample string 7",
"job_type": {
"id": "e2a2e1da-15f9-4c86-a768-b348d5e33018",
"name": "sample string 2",
"sales_organization_id": "bcbd07e9-6c07-48bf-b771-6ccb28190f9b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-15T01:05:07.3685806+00:00",
"code": "sample string 7"
},
"job_priority_id": "45c05d06-e377-40ca-89b3-c786ff6781e8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "dc98a6fc-f53e-4f61-b941-6fae7c284b74",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5f55a5af-302c-44b5-b20f-f2237b9eb192",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d848df62-1474-4b47-90cf-d7ae4a282ba2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ad32c3e-0165-4acf-94d0-7a95098dc50d",
"db_currency_id": "542fef78-12dd-4b42-9d3e-2dbfd5dd3aff",
"db_language_id": "5e5166a7-be1f-40e0-90fd-f8d4f8aef9af",
"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-05-15T01:05:07.3685806+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-15T01:05:07.3685806+00:00"
},
"job_status_id": "7c50a2d2-765f-4d33-84f7-37c6902bf912",
"job_status_code": "sample string 11",
"db_address_id": "a0de1a4c-8437-4997-aa5f-c443e6f6fa57",
"contact_id": "2821c790-00e6-48fb-a19e-a45cf0f39676",
"requested_by_company_id": "60d9b477-41fb-409f-9410-7a14fd94a8f3",
"requested_by_contact_id": "ef6876d3-7e20-4cc7-b528-a320e8828ff8",
"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-05-15T01:05:07.3685806+00:00",
"due_date": "2026-05-15T01:05:07.3685806+00:00",
"date_create": "2026-05-15T01:05:07.3685806+00:00",
"date_update": "2026-05-15T01:05:07.3685806+00:00",
"date_closed": "2026-05-15T01:05:07.3685806+00:00",
"suggested_user_id": "b6fdea6e-97f0-4fc3-ba3f-824889d3cd70",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a10b506a-1ac6-4fcf-bc74-b2b41f086b68",
"db_language_id": "cc147d17-0f90-4e5c-a727-206e7910ccb6",
"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-05-15T01:05:07.3685806+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0f57dc6b-e0a5-41dc-9a61-0c15e885343e",
"sales_organization": {
"id": "d848df62-1474-4b47-90cf-d7ae4a282ba2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ad32c3e-0165-4acf-94d0-7a95098dc50d",
"db_currency_id": "542fef78-12dd-4b42-9d3e-2dbfd5dd3aff",
"db_language_id": "5e5166a7-be1f-40e0-90fd-f8d4f8aef9af",
"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-05-15T01:05:07.3685806+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ff278328-857f-423c-9b8d-924f20c3aff0",
"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": "36b0832d-d781-4f1a-ac77-692751fafbb3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-15T01:05:07.3685806+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1838b944-bc25-4ad0-a77c-1c500dd4e1e0"
},
"suggested_date_start": "2026-05-15T01:05:07.3685806+00:00",
"skill_id": "c3d2cb77-bebc-489c-9e58-007ea3bdc2f0",
"skill_code": "sample string 32",
"skill": {
"id": "8d6de903-59dc-4382-bd43-9e213e66ae6f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9765702d-db9b-4306-8467-769012fc58b1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d848df62-1474-4b47-90cf-d7ae4a282ba2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ad32c3e-0165-4acf-94d0-7a95098dc50d",
"db_currency_id": "542fef78-12dd-4b42-9d3e-2dbfd5dd3aff",
"db_language_id": "5e5166a7-be1f-40e0-90fd-f8d4f8aef9af",
"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-05-15T01:05:07.3685806+00:00"
},
"modified_dateutc": "2026-05-15T01:05:07.3685806+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "bd1312fb-4ec8-4722-96d1-89861ade702c",
"date_reported_by_company": "2026-05-15T01:05:07.3685806+00:00",
"id2": 36,
"company_id": "693da98e-f6af-4df4-bad9-ddd6639bc419",
"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": "80a074e1-4e87-4cef-a2c2-1b61842a6750",
"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-05-15T01:05:07.3685806+00:00"
},
"work_instruction_details_id": "ce15b807-3292-4755-9195-a1f586701c32",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "286487d2-07e7-4578-a256-48c1f462e6c0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "41cc876d-f05a-4284-bf7a-562b60ad813e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-15T01:05:07.3685806+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": "12725d2e-e36f-458c-9f1f-4dc69e84c5df",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-15T01:05:07.3842064+00:00"
}