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": "d1296b6c-18cd-47a4-8acd-69016cabb767",
"jobs_id": "0f431264-a6a7-4dfe-bf64-2b4bc1d86b8e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "78d86f61-7407-46d7-bb1f-3061f6fa1ed7",
"_parent_id": "1bbd2bf4-03a5-4f89-9860-fa936dea5728",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f295d96d-a4b5-4cf7-8c5d-ce614f70e7a3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6fa3090c-1014-4c9d-8593-8271658e6f04",
"_parent_id": "eb3a9386-b1e9-4997-99a8-1bb0bb56b18d",
"root_parent_id": "d4e677dd-b9a5-4fa5-a1e0-b23198b15033",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "876d78bd-1765-4b9a-8d53-c27c14ea4202",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "fa3b9ff4-81ff-484d-b72d-2458905a9ab2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4ee73ef8-a9bd-472d-8d13-e60854ff6654",
"_parent_code": "sample string 6",
"sales_organization_id": "5b84c171-709e-4899-af76-ed4588917301",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2cb9778a-e8a7-4a55-aa96-c78f262e4a62",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a46bbedb-6f54-4eed-8dd8-06bbd8fe0099",
"db_currency_id": "b481ea7a-d13d-4a6f-82b3-ead07babde44",
"db_language_id": "35fa03f2-b214-424a-88e1-8fabbb2ab77e",
"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-06-30T16:12:15.5279992+00:00"
},
"modified_dateutc": "2026-06-30T16:12:15.5279992+00:00"
},
"equipment_model_id": "40b2dacb-ad32-4143-9c96-ecd43b3f8149",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d58f5ef2-c055-4320-8b11-c469e45ce17f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "55bb8452-a084-43f9-965e-72fd36a9d150",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "05bc27a1-d638-4d2d-ac90-592b3c05142a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b6b0471c-ca5d-434c-9966-2543b0e7e838",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2cb9778a-e8a7-4a55-aa96-c78f262e4a62",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a46bbedb-6f54-4eed-8dd8-06bbd8fe0099",
"db_currency_id": "b481ea7a-d13d-4a6f-82b3-ead07babde44",
"db_language_id": "35fa03f2-b214-424a-88e1-8fabbb2ab77e",
"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-06-30T16:12:15.5279992+00:00"
},
"modified_dateutc": "2026-06-30T16:12:15.5279992+00:00"
},
"equipment_family_id": "852b4a7f-693a-47f0-9cb3-2aeb586d1f32",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "fa3b9ff4-81ff-484d-b72d-2458905a9ab2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4ee73ef8-a9bd-472d-8d13-e60854ff6654",
"_parent_code": "sample string 6",
"sales_organization_id": "5b84c171-709e-4899-af76-ed4588917301",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2cb9778a-e8a7-4a55-aa96-c78f262e4a62",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a46bbedb-6f54-4eed-8dd8-06bbd8fe0099",
"db_currency_id": "b481ea7a-d13d-4a6f-82b3-ead07babde44",
"db_language_id": "35fa03f2-b214-424a-88e1-8fabbb2ab77e",
"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-06-30T16:12:15.5279992+00:00"
},
"modified_dateutc": "2026-06-30T16:12:15.5279992+00:00"
},
"date_in_production_since": "2026-06-30T16:12:15.5279992+00:00",
"date_out_of_production_since": "2026-06-30T16:12:15.5279992+00:00",
"date_end_support": "2026-06-30T16:12:15.5279992+00:00",
"sales_organization_id": "638e2267-627e-439e-b1ab-1fbb5ebba1fc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2cb9778a-e8a7-4a55-aa96-c78f262e4a62",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a46bbedb-6f54-4eed-8dd8-06bbd8fe0099",
"db_currency_id": "b481ea7a-d13d-4a6f-82b3-ead07babde44",
"db_language_id": "35fa03f2-b214-424a-88e1-8fabbb2ab77e",
"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-06-30T16:12:15.5279992+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-06-30T16:12:15.5279992+00:00"
},
"project_status_id": "2fea0fbc-10d5-45c9-96d5-41e632757094",
"project_status_code": "sample string 10",
"project_status": {
"id": "c90ca521-39d6-4617-a993-a9feeb69a6fa",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "528695bb-64d7-415f-bcc3-82a7bcb94d90",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2cb9778a-e8a7-4a55-aa96-c78f262e4a62",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a46bbedb-6f54-4eed-8dd8-06bbd8fe0099",
"db_currency_id": "b481ea7a-d13d-4a6f-82b3-ead07babde44",
"db_language_id": "35fa03f2-b214-424a-88e1-8fabbb2ab77e",
"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-06-30T16:12:15.5279992+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-30T16:12:15.5279992+00:00"
},
"company_id": "2ea527c3-19d0-4b45-9aa6-2ed108ac3588",
"company_code": "sample string 12",
"db_address_id": "f217ceed-225f-4ff8-aaf8-b734342f4c22",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e71b1780-c067-4a4c-bd42-fbc9d777bac7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8ae0fa52-738b-46f4-a9fa-35ab26aac0c3",
"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-06-30T16:12:15.5279992+00:00",
"date_create": "2026-06-30T16:12:15.5279992+00:00",
"date_update": "2026-06-30T16:12:15.5279992+00:00",
"updated_by_user_id": "cd2bd23f-778f-4a8e-9e45-a83ed8774890",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-30T16:12:15.5279992+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-06-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-30T16:12:15.5279992+00:00",
"date_last_job": "2026-06-30T16:12:15.5279992+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-30T16:12:15.5279992+00:00",
"modified_dateutc": "2026-06-30T16:12:15.5279992+00:00",
"is_mobile_installation": true
},
"job_type_id": "787758f5-e1f6-4ffb-abfd-a69087e01c8d",
"job_type_code": "sample string 7",
"job_type": {
"id": "55432329-5160-410a-8fba-aa16a865a0b7",
"name": "sample string 2",
"sales_organization_id": "4ec1a387-1858-44bc-92bf-91258eeb235f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-30T16:12:15.5279992+00:00",
"code": "sample string 7"
},
"job_priority_id": "fb313be4-d81c-46c0-a806-97c74ed0ea71",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f13628bf-3718-4423-b5b3-586f983f8f5b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "018e03ea-fe5e-4ffc-a395-aa1e258a6738",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2cb9778a-e8a7-4a55-aa96-c78f262e4a62",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a46bbedb-6f54-4eed-8dd8-06bbd8fe0099",
"db_currency_id": "b481ea7a-d13d-4a6f-82b3-ead07babde44",
"db_language_id": "35fa03f2-b214-424a-88e1-8fabbb2ab77e",
"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-06-30T16:12:15.5279992+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-30T16:12:15.5279992+00:00"
},
"job_status_id": "0f24864a-852a-4491-954b-fc8aa22d54ad",
"job_status_code": "sample string 11",
"db_address_id": "6ccce46f-b062-4cc8-8b1d-61ccf8345ffb",
"contact_id": "5d86178b-5699-4ad5-887d-453abeca92b2",
"requested_by_company_id": "d068b764-a0d2-4855-95bb-db3da76702c4",
"requested_by_contact_id": "f5e9cf2a-3f6a-45b1-81fe-29ba1c516b37",
"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-06-30T16:12:15.5279992+00:00",
"due_date": "2026-06-30T16:12:15.5279992+00:00",
"date_create": "2026-06-30T16:12:15.5279992+00:00",
"date_update": "2026-06-30T16:12:15.5279992+00:00",
"date_closed": "2026-06-30T16:12:15.5279992+00:00",
"suggested_user_id": "3b8525bc-26e8-42b8-ab24-d41a71622186",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "14b69ace-2427-47f9-8291-9c54ed702a51",
"db_language_id": "cd59f795-94b2-45ca-ab19-fd80e3a9ed2e",
"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-06-30T16:12:15.5279992+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b5676526-0d07-4922-8781-780641c9617d",
"sales_organization": {
"id": "2cb9778a-e8a7-4a55-aa96-c78f262e4a62",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a46bbedb-6f54-4eed-8dd8-06bbd8fe0099",
"db_currency_id": "b481ea7a-d13d-4a6f-82b3-ead07babde44",
"db_language_id": "35fa03f2-b214-424a-88e1-8fabbb2ab77e",
"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-06-30T16:12:15.5279992+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "cccb0922-639f-4a97-b068-ca83ba0be0d5",
"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": "570c634f-9535-464b-8039-85ea0f4124f4",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-30T16:12:15.5279992+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "fc5514e3-c6f3-4544-a639-3948b9d5c138"
},
"suggested_date_start": "2026-06-30T16:12:15.5279992+00:00",
"skill_id": "528dd81a-723e-4b5a-a474-8ff76074113b",
"skill_code": "sample string 32",
"skill": {
"id": "bef182b8-588a-43e0-a30f-aff3d6b043d8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7a3e6144-735e-4b64-a642-1c91235f889a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2cb9778a-e8a7-4a55-aa96-c78f262e4a62",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a46bbedb-6f54-4eed-8dd8-06bbd8fe0099",
"db_currency_id": "b481ea7a-d13d-4a6f-82b3-ead07babde44",
"db_language_id": "35fa03f2-b214-424a-88e1-8fabbb2ab77e",
"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-06-30T16:12:15.5279992+00:00"
},
"modified_dateutc": "2026-06-30T16:12:15.5279992+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "42ce3b68-b1a4-4ca3-97c2-eba9df5992bc",
"date_reported_by_company": "2026-06-30T16:12:15.5279992+00:00",
"id2": 36,
"company_id": "8b1ab446-ae45-4d6f-ae18-5127042aee6c",
"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": "8ffbd492-d0d1-4c64-89a6-d34c5bb0bbe5",
"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-06-30T16:12:15.5279992+00:00"
},
"work_instruction_details_id": "303c9f34-f756-4031-94f4-d6c147f04676",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "20227a3f-2d66-4efc-9270-76370b39d36c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "82341d4f-6e3d-4060-abb6-27597df51c09",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-30T16:12:15.5279992+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": "4417a74a-927e-420f-ba8d-e65b9edfcef5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-30T16:12:15.5279992+00:00"
}