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": "0bee24e6-3cb8-41d3-ad38-651d60dd4e72",
"jobs_id": "4938d247-11b6-4cdd-81ee-42ecf3ba18e9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e8ba0866-9d73-4b7e-9c28-8bc5a477100c",
"_parent_id": "1e83ab1f-c5ce-43f9-a770-6f33ece62a98",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2c407050-3eab-41ee-9dea-bcba67732db1",
"project_reference_back_office": "sample string 5",
"project": {
"id": "142cbfc2-4c03-4cc1-8688-cc80a7882100",
"_parent_id": "0350f9ff-e557-4beb-adb0-7f5f07b5bd0e",
"root_parent_id": "3c85bc65-3ea3-4768-8531-7444d7a5b77d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "45a28fb2-0734-475b-9fce-5ee80e66457d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7decb25b-57e4-415b-99b6-f3457b370e47",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3cbd8ee4-0f33-452e-8d59-b52c56b3ce0d",
"_parent_code": "sample string 6",
"sales_organization_id": "5829fd7a-e543-47aa-aec4-be3f3339c003",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fec50a02-ddf6-4240-ab48-fe0d8b5b2334",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "056b1d52-84b9-4dd2-b78e-3d451df69be1",
"db_currency_id": "88942125-c114-4d93-9084-9bfb1542aa5b",
"db_language_id": "77678df5-487e-4590-b493-215899ef616d",
"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-10-17T11:28:40.3861763+00:00"
},
"modified_dateutc": "2026-10-17T11:28:40.3861763+00:00"
},
"equipment_model_id": "1b85b7d0-72fb-4ffe-bbbb-cb5a86381170",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "022c5318-c10e-415a-bcb5-ba5c5413e8d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d8ecc11b-48c5-44b3-8f20-aef63890d2ab",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2d5fbd02-5592-4434-93fc-c3f26b6732c6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "cdf69cd5-5b03-4acd-9439-b9340569cb74",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fec50a02-ddf6-4240-ab48-fe0d8b5b2334",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "056b1d52-84b9-4dd2-b78e-3d451df69be1",
"db_currency_id": "88942125-c114-4d93-9084-9bfb1542aa5b",
"db_language_id": "77678df5-487e-4590-b493-215899ef616d",
"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-10-17T11:28:40.3861763+00:00"
},
"modified_dateutc": "2026-10-17T11:28:40.3861763+00:00"
},
"equipment_family_id": "0c542ea2-0a93-49ac-aad7-3551702d72e9",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7decb25b-57e4-415b-99b6-f3457b370e47",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3cbd8ee4-0f33-452e-8d59-b52c56b3ce0d",
"_parent_code": "sample string 6",
"sales_organization_id": "5829fd7a-e543-47aa-aec4-be3f3339c003",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fec50a02-ddf6-4240-ab48-fe0d8b5b2334",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "056b1d52-84b9-4dd2-b78e-3d451df69be1",
"db_currency_id": "88942125-c114-4d93-9084-9bfb1542aa5b",
"db_language_id": "77678df5-487e-4590-b493-215899ef616d",
"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-10-17T11:28:40.3861763+00:00"
},
"modified_dateutc": "2026-10-17T11:28:40.3861763+00:00"
},
"date_in_production_since": "2026-10-17T11:28:40.3861763+00:00",
"date_out_of_production_since": "2026-10-17T11:28:40.3861763+00:00",
"date_end_support": "2026-10-17T11:28:40.3861763+00:00",
"sales_organization_id": "3ad5936f-4f2a-4e89-b22a-f4520bc505bc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fec50a02-ddf6-4240-ab48-fe0d8b5b2334",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "056b1d52-84b9-4dd2-b78e-3d451df69be1",
"db_currency_id": "88942125-c114-4d93-9084-9bfb1542aa5b",
"db_language_id": "77678df5-487e-4590-b493-215899ef616d",
"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-10-17T11:28:40.3861763+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-10-17T11:28:40.4052326+00:00"
},
"project_status_id": "960b1f1d-f59e-4e74-9606-0c00614b0268",
"project_status_code": "sample string 10",
"project_status": {
"id": "6fbc5b22-848a-4a16-aeed-46ed5d8b4213",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b58dddf8-fefc-4200-a181-2e2700ab6086",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fec50a02-ddf6-4240-ab48-fe0d8b5b2334",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "056b1d52-84b9-4dd2-b78e-3d451df69be1",
"db_currency_id": "88942125-c114-4d93-9084-9bfb1542aa5b",
"db_language_id": "77678df5-487e-4590-b493-215899ef616d",
"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-10-17T11:28:40.3861763+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-17T11:28:40.4052326+00:00"
},
"company_id": "99f62765-cbaa-40ca-94bb-56c70b574814",
"company_code": "sample string 12",
"db_address_id": "73815b0c-b852-4657-ab9b-feb8fc9f05f4",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ad2eb671-3159-42f1-a1d9-c8b8c7121f17",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e34e5da4-4e3f-4db3-bb80-0aebbfe79332",
"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-10-17T11:28:40.4052326+00:00",
"date_create": "2026-10-17T11:28:40.4052326+00:00",
"date_update": "2026-10-17T11:28:40.4052326+00:00",
"updated_by_user_id": "1735a240-cf2e-49bc-bd00-169b41ced007",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-17T11:28:40.4052326+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-10-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-17T11:28:40.4052326+00:00",
"date_last_job": "2026-10-17T11:28:40.4052326+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-17T11:28:40.4052326+00:00",
"modified_dateutc": "2026-10-17T11:28:40.4052326+00:00",
"is_mobile_installation": true
},
"job_type_id": "cefb7fd6-e542-4236-81ce-66c5bf552afa",
"job_type_code": "sample string 7",
"job_type": {
"id": "cfad027f-dc1e-4e5e-8a03-58f55b027919",
"name": "sample string 2",
"sales_organization_id": "3adbf3cc-c0b2-48dd-b297-89278817c627",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-17T11:28:40.4052326+00:00",
"code": "sample string 7"
},
"job_priority_id": "96d6c173-f6a0-4b3a-8681-d3a3bc2913d4",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0f49ae77-adaf-4307-b00f-b74958361512",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "479e05cc-edf2-4088-b196-661730af660b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fec50a02-ddf6-4240-ab48-fe0d8b5b2334",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "056b1d52-84b9-4dd2-b78e-3d451df69be1",
"db_currency_id": "88942125-c114-4d93-9084-9bfb1542aa5b",
"db_language_id": "77678df5-487e-4590-b493-215899ef616d",
"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-10-17T11:28:40.3861763+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-17T11:28:40.4052326+00:00"
},
"job_status_id": "3ac0d410-1b53-45e0-8b4d-0e2a24e9e4b4",
"job_status_code": "sample string 11",
"db_address_id": "a4fcfbf1-fdd4-470a-b0dc-a893e07c42b6",
"contact_id": "14caf53e-6f55-4bdf-858c-843ccce4eec4",
"requested_by_company_id": "319aeda4-446b-4fb6-be69-562a2a7dab75",
"requested_by_contact_id": "c2dd0445-723f-4573-ba55-45e446a439d0",
"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-10-17T11:28:40.4052326+00:00",
"due_date": "2026-10-17T11:28:40.4052326+00:00",
"date_create": "2026-10-17T11:28:40.4052326+00:00",
"date_update": "2026-10-17T11:28:40.4052326+00:00",
"date_closed": "2026-10-17T11:28:40.4052326+00:00",
"suggested_user_id": "04a4276c-6f61-4b30-827d-10562bb4cd1f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "eb540d11-bfb2-48e2-9a95-c3a17ca6a445",
"db_language_id": "3822f096-8cb5-4ed0-822a-7167eeeb7b35",
"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-10-17T11:28:40.4052326+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8edb01e9-f159-411a-9deb-9614c492d23d",
"sales_organization": {
"id": "fec50a02-ddf6-4240-ab48-fe0d8b5b2334",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "056b1d52-84b9-4dd2-b78e-3d451df69be1",
"db_currency_id": "88942125-c114-4d93-9084-9bfb1542aa5b",
"db_language_id": "77678df5-487e-4590-b493-215899ef616d",
"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-10-17T11:28:40.3861763+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "bf00309c-739a-445d-b631-497134927df7",
"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": "0263305e-13fc-451a-b39e-05ff5432d972",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-17T11:28:40.4052326+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5e5bdffd-1a49-4dc4-a6bf-2bc3e15d66a0"
},
"suggested_date_start": "2026-10-17T11:28:40.4052326+00:00",
"skill_id": "d57fdebb-a2e7-44c4-8ede-c8c5ce910418",
"skill_code": "sample string 32",
"skill": {
"id": "0b4846d2-76b2-46cc-8021-6f073dfb55b7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "dfcdbe0c-903a-402a-8ba5-772756142276",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fec50a02-ddf6-4240-ab48-fe0d8b5b2334",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "056b1d52-84b9-4dd2-b78e-3d451df69be1",
"db_currency_id": "88942125-c114-4d93-9084-9bfb1542aa5b",
"db_language_id": "77678df5-487e-4590-b493-215899ef616d",
"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-10-17T11:28:40.3861763+00:00"
},
"modified_dateutc": "2026-10-17T11:28:40.4052326+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "39096702-a4f1-4020-bd07-6c9015dad27d",
"date_reported_by_company": "2026-10-17T11:28:40.4052326+00:00",
"id2": 36,
"company_id": "500738fa-539c-435d-b12e-3bab2cfc8060",
"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": "96899f82-228b-4aeb-ade2-f38e9d8308b3",
"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-10-17T11:28:40.4052326+00:00"
},
"work_instruction_details_id": "84193b83-9613-424a-ad2a-64ba339bc0c9",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c1c13cde-4db6-4822-8f0f-5e6acc4a87b1",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ebded536-c3e8-43d3-88bf-4927bbfdc53b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-17T11:28:40.4052326+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": "45559890-b644-4b3a-896d-ad3838e5e496",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-17T11:28:40.4052326+00:00"
}