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": "fe3c5c4c-49dd-43e9-b0b7-1ef328584068",
"jobs_id": "ed339b58-d03d-4c4b-8ca4-30700d613d80",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ace9a4e2-2fed-4a3d-bdc1-0359a2adb9f5",
"_parent_id": "cbdbac6b-31ab-4151-9c2b-bb15c069259f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b2626f7b-9c92-473c-839b-60a0c42bbf7b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2c1522be-544e-43a6-b5a5-c13c238111e2",
"_parent_id": "acf7545c-c240-4f59-9919-fbca7ae55c8f",
"root_parent_id": "74be752d-b39d-4cdd-8132-d1604f3f451f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "299663dc-efb0-4bd1-b057-f88144a5f0b2",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4c52bb80-1d3b-4354-b208-7201b6ad53ef",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cd77f746-9138-49fa-bdc9-4f584e52eba1",
"_parent_code": "sample string 6",
"sales_organization_id": "55b0920f-4bf1-435a-95c5-9eb9069fdcd9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6d74dcbf-96e6-4d99-869e-ea00c09d54b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a4c9a12-e7c0-41b0-8a9c-b3505ce96c54",
"db_currency_id": "5cd36cb9-30a2-4e86-a13f-ab31f0a38787",
"db_language_id": "2dfc736e-71e6-44d2-8c50-a3eb9dfcc4f2",
"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-29T13:16:59.0705714+00:00"
},
"modified_dateutc": "2026-10-29T13:16:59.0705714+00:00"
},
"equipment_model_id": "4e05703c-1255-4008-8063-359217c8a6c9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d59bc66d-37ab-4c24-8029-ddbcee04fbd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "88c34100-2e4d-4ac9-9c1c-6ead54f40b4f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2444d66d-4ef5-4259-9e3b-30576e980853",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "016f47a6-6faf-408f-8ee2-46c36a06c64b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6d74dcbf-96e6-4d99-869e-ea00c09d54b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a4c9a12-e7c0-41b0-8a9c-b3505ce96c54",
"db_currency_id": "5cd36cb9-30a2-4e86-a13f-ab31f0a38787",
"db_language_id": "2dfc736e-71e6-44d2-8c50-a3eb9dfcc4f2",
"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-29T13:16:59.0705714+00:00"
},
"modified_dateutc": "2026-10-29T13:16:59.0705714+00:00"
},
"equipment_family_id": "d446e913-22be-48f4-9dd6-7b773bd592c9",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4c52bb80-1d3b-4354-b208-7201b6ad53ef",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cd77f746-9138-49fa-bdc9-4f584e52eba1",
"_parent_code": "sample string 6",
"sales_organization_id": "55b0920f-4bf1-435a-95c5-9eb9069fdcd9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6d74dcbf-96e6-4d99-869e-ea00c09d54b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a4c9a12-e7c0-41b0-8a9c-b3505ce96c54",
"db_currency_id": "5cd36cb9-30a2-4e86-a13f-ab31f0a38787",
"db_language_id": "2dfc736e-71e6-44d2-8c50-a3eb9dfcc4f2",
"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-29T13:16:59.0705714+00:00"
},
"modified_dateutc": "2026-10-29T13:16:59.0705714+00:00"
},
"date_in_production_since": "2026-10-29T13:16:59.0705714+00:00",
"date_out_of_production_since": "2026-10-29T13:16:59.0705714+00:00",
"date_end_support": "2026-10-29T13:16:59.0705714+00:00",
"sales_organization_id": "b1ba3b69-b5cf-4714-9ca7-c97978cde4a0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6d74dcbf-96e6-4d99-869e-ea00c09d54b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a4c9a12-e7c0-41b0-8a9c-b3505ce96c54",
"db_currency_id": "5cd36cb9-30a2-4e86-a13f-ab31f0a38787",
"db_language_id": "2dfc736e-71e6-44d2-8c50-a3eb9dfcc4f2",
"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-29T13:16:59.0705714+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-29T13:16:59.0705714+00:00"
},
"project_status_id": "dbfa7343-28d1-4738-bfe6-64134d2ebe9a",
"project_status_code": "sample string 10",
"project_status": {
"id": "d033b1ab-c6d6-4278-9f57-2948ac422317",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3b247af8-978a-4c93-acac-243776106d94",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6d74dcbf-96e6-4d99-869e-ea00c09d54b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a4c9a12-e7c0-41b0-8a9c-b3505ce96c54",
"db_currency_id": "5cd36cb9-30a2-4e86-a13f-ab31f0a38787",
"db_language_id": "2dfc736e-71e6-44d2-8c50-a3eb9dfcc4f2",
"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-29T13:16:59.0705714+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-29T13:16:59.0705714+00:00"
},
"company_id": "c4043cd6-6b6e-4413-b91e-447e9099afdf",
"company_code": "sample string 12",
"db_address_id": "1aed26bb-1593-46a3-90d3-639baaa7b16c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6dfb90ea-78a4-4c01-a864-48125e4b1302",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "69602d8f-5465-4cac-8852-b06c0273f3fd",
"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-29T13:16:59.0705714+00:00",
"date_create": "2026-10-29T13:16:59.0705714+00:00",
"date_update": "2026-10-29T13:16:59.0705714+00:00",
"updated_by_user_id": "5237fbf7-435a-4095-8208-f0b04da2f03e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-29T13:16:59.0705714+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-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-29T13:16:59.0705714+00:00",
"date_last_job": "2026-10-29T13:16:59.0705714+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-29T13:16:59.0705714+00:00",
"modified_dateutc": "2026-10-29T13:16:59.0705714+00:00",
"is_mobile_installation": true
},
"job_type_id": "29ef8c86-07e8-4106-8c7d-2a481e2f48e4",
"job_type_code": "sample string 7",
"job_type": {
"id": "de8b3fc7-c029-4994-acbe-f7a52d780bc5",
"name": "sample string 2",
"sales_organization_id": "c6d39552-a104-4476-a6f2-74114883b6a8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-29T13:16:59.0705714+00:00",
"code": "sample string 7"
},
"job_priority_id": "6382da04-f286-49c6-83a7-3cacf9b48b79",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f8256e8a-ac15-4d18-adb6-55cf8ce9349c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "831a9d43-0286-4077-95dd-ae98066faa6b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6d74dcbf-96e6-4d99-869e-ea00c09d54b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a4c9a12-e7c0-41b0-8a9c-b3505ce96c54",
"db_currency_id": "5cd36cb9-30a2-4e86-a13f-ab31f0a38787",
"db_language_id": "2dfc736e-71e6-44d2-8c50-a3eb9dfcc4f2",
"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-29T13:16:59.0705714+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-29T13:16:59.0705714+00:00"
},
"job_status_id": "658af37d-5a4d-4edc-b7b0-6b36e796ec6d",
"job_status_code": "sample string 11",
"db_address_id": "2cda3802-e847-435b-a7fb-3e9c9686429f",
"contact_id": "172a2047-f69b-4453-91a0-dfbe9ef5c865",
"requested_by_company_id": "6324efe9-114d-4a65-b75c-04487fddc7d8",
"requested_by_contact_id": "b716e53d-0936-4999-a769-3a42af2ccfcc",
"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-29T13:16:59.0705714+00:00",
"due_date": "2026-10-29T13:16:59.0705714+00:00",
"date_create": "2026-10-29T13:16:59.0705714+00:00",
"date_update": "2026-10-29T13:16:59.0705714+00:00",
"date_closed": "2026-10-29T13:16:59.0705714+00:00",
"suggested_user_id": "7b07261b-60db-45a4-b54e-9905d7de0d28",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "da19436e-19ef-40ba-bbc8-4c202b569fcc",
"db_language_id": "a5072403-7fc0-432c-8069-5984f971993a",
"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-29T13:16:59.0882391+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "11fb10ab-081e-4d74-8cb7-efd51d2849fc",
"sales_organization": {
"id": "6d74dcbf-96e6-4d99-869e-ea00c09d54b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a4c9a12-e7c0-41b0-8a9c-b3505ce96c54",
"db_currency_id": "5cd36cb9-30a2-4e86-a13f-ab31f0a38787",
"db_language_id": "2dfc736e-71e6-44d2-8c50-a3eb9dfcc4f2",
"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-29T13:16:59.0705714+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "216144f5-c589-4caf-886e-e9b527bd6ea0",
"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": "c12e92ad-2288-480e-a065-95119f0fb6a9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-29T13:16:59.0882391+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "14585b3b-0c34-4e18-82d4-54c03bb94826"
},
"suggested_date_start": "2026-10-29T13:16:59.0882391+00:00",
"skill_id": "e369f389-37d2-4914-ac40-4d66c706b60e",
"skill_code": "sample string 32",
"skill": {
"id": "573c7d90-66ad-4e2e-9a08-54df732fcf03",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f4c81617-a95d-4077-a3e9-3086993ea0da",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6d74dcbf-96e6-4d99-869e-ea00c09d54b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a4c9a12-e7c0-41b0-8a9c-b3505ce96c54",
"db_currency_id": "5cd36cb9-30a2-4e86-a13f-ab31f0a38787",
"db_language_id": "2dfc736e-71e6-44d2-8c50-a3eb9dfcc4f2",
"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-29T13:16:59.0705714+00:00"
},
"modified_dateutc": "2026-10-29T13:16:59.0882391+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f61dac0f-d0c2-41c7-b49b-c35244dfe2d9",
"date_reported_by_company": "2026-10-29T13:16:59.0882391+00:00",
"id2": 36,
"company_id": "fc00faf2-18f1-4b41-a4a4-4eb231caec2d",
"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": "074ac451-b6d8-40a1-aac3-d99c77e1fe4c",
"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-29T13:16:59.0882391+00:00"
},
"work_instruction_details_id": "f400649b-e72e-4bcd-a7cf-efc0c12b56cb",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7a0a65f8-cd87-4973-88b8-0ef1f579e191",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "de474738-ac34-4a98-9f30-8874b8b88b45",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-29T13:16:59.0882391+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": "d3b52d2c-012a-4a1e-806c-30b4f5e3effa",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-29T13:16:59.0882391+00:00"
}