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": "0489cf95-31b0-4033-88eb-2a4d57a99a5a",
"jobs_id": "9d6d5d37-706b-418d-8425-ded4ddd6a213",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f3e823ca-6f20-42fe-bef7-b56f26f831b8",
"_parent_id": "33d6a5b5-bda0-4e0c-9f07-591fbacebc14",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "01888c27-f024-474d-b21e-a127922d1f72",
"project_reference_back_office": "sample string 5",
"project": {
"id": "83f4bea1-d768-4b5b-8787-611f27a80588",
"_parent_id": "7978ace4-ce8d-4dde-999c-86130d48cc05",
"root_parent_id": "0612f900-c09f-4d56-a8cb-d2b3d5eaefc1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d51ecbe0-d100-44c7-b886-dfbbba8121dd",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c9875ce9-c4c2-4032-bf14-d430ec2fef05",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b739a76e-0dba-4491-bbaf-8e45284164b8",
"_parent_code": "sample string 6",
"sales_organization_id": "5dd72968-f59b-4e98-a8d0-c281b512deec",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "23d165d5-6303-4d7c-ab69-a727f136f99b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6a4a448-3888-4f8f-8a36-19ba92bde6e6",
"db_currency_id": "4713b0ff-c798-4ff8-8b51-dcb95a28650f",
"db_language_id": "d76d9657-c4ec-4e51-aee8-c09575e8176a",
"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-10-08T18:22:05.7777553+00:00"
},
"modified_dateutc": "2025-10-08T18:22:05.7777553+00:00"
},
"equipment_model_id": "aff6039e-61a5-4fbc-aaf5-6756d4c378de",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c4ce8ba2-e681-438f-a35c-9b9b275f7672",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7ee55020-9f9b-47f7-a8d9-d4c231c32afd",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ec4044f8-233a-47b8-9727-e7154263e867",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "049de734-635f-4ab3-a607-22916ec520f6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "23d165d5-6303-4d7c-ab69-a727f136f99b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6a4a448-3888-4f8f-8a36-19ba92bde6e6",
"db_currency_id": "4713b0ff-c798-4ff8-8b51-dcb95a28650f",
"db_language_id": "d76d9657-c4ec-4e51-aee8-c09575e8176a",
"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-10-08T18:22:05.7777553+00:00"
},
"modified_dateutc": "2025-10-08T18:22:05.7777553+00:00"
},
"equipment_family_id": "6fdd967c-7876-4983-b3ac-383b545e98eb",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c9875ce9-c4c2-4032-bf14-d430ec2fef05",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b739a76e-0dba-4491-bbaf-8e45284164b8",
"_parent_code": "sample string 6",
"sales_organization_id": "5dd72968-f59b-4e98-a8d0-c281b512deec",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "23d165d5-6303-4d7c-ab69-a727f136f99b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6a4a448-3888-4f8f-8a36-19ba92bde6e6",
"db_currency_id": "4713b0ff-c798-4ff8-8b51-dcb95a28650f",
"db_language_id": "d76d9657-c4ec-4e51-aee8-c09575e8176a",
"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-10-08T18:22:05.7777553+00:00"
},
"modified_dateutc": "2025-10-08T18:22:05.7777553+00:00"
},
"date_in_production_since": "2025-10-08T18:22:05.7777553+00:00",
"date_out_of_production_since": "2025-10-08T18:22:05.7777553+00:00",
"date_end_support": "2025-10-08T18:22:05.7777553+00:00",
"sales_organization_id": "2f20273b-0c6d-41e2-b137-a706b6f282d3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "23d165d5-6303-4d7c-ab69-a727f136f99b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6a4a448-3888-4f8f-8a36-19ba92bde6e6",
"db_currency_id": "4713b0ff-c798-4ff8-8b51-dcb95a28650f",
"db_language_id": "d76d9657-c4ec-4e51-aee8-c09575e8176a",
"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-10-08T18:22:05.7777553+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-10-08T18:22:05.7777553+00:00"
},
"project_status_id": "279bc2f2-5e93-4646-be6f-4a5e381ba15d",
"project_status_code": "sample string 10",
"project_status": {
"id": "388a20d9-5707-41e0-bdd5-686dbfbc5fcd",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a27d2020-520d-489f-b3ac-f3835a6af20e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "23d165d5-6303-4d7c-ab69-a727f136f99b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6a4a448-3888-4f8f-8a36-19ba92bde6e6",
"db_currency_id": "4713b0ff-c798-4ff8-8b51-dcb95a28650f",
"db_language_id": "d76d9657-c4ec-4e51-aee8-c09575e8176a",
"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-10-08T18:22:05.7777553+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-08T18:22:05.7777553+00:00"
},
"company_id": "128a2c70-3458-4c74-a1d3-d5ce635d77af",
"company_code": "sample string 12",
"db_address_id": "b6d8c97b-a4fa-41bb-b0c0-96b4d2898ef1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f8ab6fb2-fa4f-43e5-bb08-827800120db8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2034358e-448e-43f3-9764-c3f4924c8ee1",
"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-10-08T18:22:05.7777553+00:00",
"date_create": "2025-10-08T18:22:05.7777553+00:00",
"date_update": "2025-10-08T18:22:05.7777553+00:00",
"updated_by_user_id": "e991ef01-2589-4bbd-96d9-a1cdcb5832e9",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-10-08T18:22:05.7777553+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-10-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-10-08T18:22:05.7777553+00:00",
"date_last_job": "2025-10-08T18:22:05.7777553+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-10-08T18:22:05.7777553+00:00",
"modified_dateutc": "2025-10-08T18:22:05.7777553+00:00",
"is_mobile_installation": true
},
"job_type_id": "ae41ddd4-a138-4571-ace0-816a7ec1c67c",
"job_type_code": "sample string 7",
"job_type": {
"id": "26a5433a-4c49-4709-8018-fe04a4e616c3",
"name": "sample string 2",
"sales_organization_id": "06b1ee33-81f7-421e-b192-2a155ae73bde",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-10-08T18:22:05.7777553+00:00",
"code": "sample string 7"
},
"job_priority_id": "a2d5dafb-7938-4eea-ada3-683dfc5cdaab",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "70994b87-f614-4059-b431-045fdcadb1e8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "972296e9-e4c6-44bb-9df0-50da1d9941a3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "23d165d5-6303-4d7c-ab69-a727f136f99b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6a4a448-3888-4f8f-8a36-19ba92bde6e6",
"db_currency_id": "4713b0ff-c798-4ff8-8b51-dcb95a28650f",
"db_language_id": "d76d9657-c4ec-4e51-aee8-c09575e8176a",
"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-10-08T18:22:05.7777553+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-08T18:22:05.7777553+00:00"
},
"job_status_id": "74b97431-713f-4947-8062-0a6636916093",
"job_status_code": "sample string 11",
"db_address_id": "e78ba04f-094b-4340-9013-cd3123ad2007",
"contact_id": "a8de33dc-50eb-4ae0-86a8-fa6e222e25d6",
"requested_by_company_id": "6f47c1b7-86ef-4421-b33a-8ae332d6dab9",
"requested_by_contact_id": "ac1fabd6-e068-48b1-a1e9-ed509712eb75",
"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-10-08T18:22:05.7777553+00:00",
"due_date": "2025-10-08T18:22:05.7777553+00:00",
"date_create": "2025-10-08T18:22:05.7777553+00:00",
"date_update": "2025-10-08T18:22:05.7777553+00:00",
"date_closed": "2025-10-08T18:22:05.7777553+00:00",
"suggested_user_id": "94e41358-b362-4dce-9b5f-b8f505c1e6d3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d95e8a23-cc82-4b28-9b43-4d44436590c4",
"db_language_id": "3b5213db-b479-4f19-8c79-c9b13b3004c6",
"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-10-08T18:22:05.7777553+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6e4234fe-26bd-491b-bf79-84e19cbaf86e",
"sales_organization": {
"id": "23d165d5-6303-4d7c-ab69-a727f136f99b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6a4a448-3888-4f8f-8a36-19ba92bde6e6",
"db_currency_id": "4713b0ff-c798-4ff8-8b51-dcb95a28650f",
"db_language_id": "d76d9657-c4ec-4e51-aee8-c09575e8176a",
"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-10-08T18:22:05.7777553+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "403bdce1-6469-40ed-93fb-699b798d743b",
"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": "ce4376b0-5181-4fd4-a1eb-2cf40c76a53e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-08T18:22:05.7777553+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f27e20f9-218e-4385-8aaa-dbae10dc4a97"
},
"suggested_date_start": "2025-10-08T18:22:05.7777553+00:00",
"skill_id": "9a70d21c-df97-4e08-af3a-557a7e879c1e",
"skill_code": "sample string 32",
"skill": {
"id": "440b084e-975c-45b2-8f0d-5d238b2789d0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b67a9331-3f52-4f46-aa25-7e1f4de6583f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "23d165d5-6303-4d7c-ab69-a727f136f99b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6a4a448-3888-4f8f-8a36-19ba92bde6e6",
"db_currency_id": "4713b0ff-c798-4ff8-8b51-dcb95a28650f",
"db_language_id": "d76d9657-c4ec-4e51-aee8-c09575e8176a",
"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-10-08T18:22:05.7777553+00:00"
},
"modified_dateutc": "2025-10-08T18:22:05.7777553+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6fd39ee2-ead5-4b5f-83b3-8e3c49ae22b6",
"date_reported_by_company": "2025-10-08T18:22:05.7777553+00:00",
"id2": 36,
"company_id": "2f9e520b-f93b-4afc-a0f4-46080d040651",
"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": "0931ea0c-8beb-4d54-b206-5a7b5e5c6eaf",
"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-10-08T18:22:05.7777553+00:00"
},
"work_instruction_details_id": "466fb9e1-bda4-408a-9b1a-4fc46f84013c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "765028d2-5b4b-483b-9f7d-7207b673bbae",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bcee15da-1301-43cc-8688-25bd116d697d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-10-08T18:22:05.7777553+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": "502abb82-c522-4334-af7b-0ec60e80e71b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-10-08T18:22:05.7777553+00:00"
}