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": "90683b06-2fb9-4f1a-a848-275e7a56aa82",
"jobs_id": "a966d272-20fc-4ca0-b579-613e728c5ea5",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f7609a42-bf1c-4943-ab65-6fe5161ecadd",
"_parent_id": "6d8e03d0-f354-48f1-9787-a4d348a410eb",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3389b978-11d3-40cc-9414-30ffff44b008",
"project_reference_back_office": "sample string 5",
"project": {
"id": "cc945250-5bad-4a89-a56c-7e71654f2356",
"_parent_id": "19c9c0df-b555-4e6b-b294-4975c02a3653",
"root_parent_id": "4ae9ffa6-50b8-4468-aa92-e8f25a6f2388",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "96ca91bc-e739-4605-b725-df9409e04312",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "92b5b24f-17f6-4177-a091-e67b9c880daf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e4d9b406-b7e0-432b-89b9-7f66b0881aff",
"_parent_code": "sample string 6",
"sales_organization_id": "108aeb9e-1256-4f46-a473-aade59abe5fa",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ca0772ee-9521-4bfe-89af-e7c115cc8bf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "58e54c6f-d4ca-41c0-8d3c-f6490b0e0e4a",
"db_currency_id": "987e89b9-429c-43b7-8f0f-e84275ef19e8",
"db_language_id": "ee9ca2ee-2dfc-494c-aef9-c3b772401338",
"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-12-23T09:40:58.7621075+00:00"
},
"modified_dateutc": "2025-12-23T09:40:58.7621075+00:00"
},
"equipment_model_id": "9f87c93f-be6f-4594-b068-0efe39f8d8e4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6b63ff4e-0de7-4a25-8e93-21d087a12ffb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1a98472f-efc5-4599-8c81-fa3c1bce7c82",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1b06cc4a-68e0-4b8e-abe8-b2d4802c2caf",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a87bd5c6-f129-4498-811d-21eacce4bc9a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ca0772ee-9521-4bfe-89af-e7c115cc8bf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "58e54c6f-d4ca-41c0-8d3c-f6490b0e0e4a",
"db_currency_id": "987e89b9-429c-43b7-8f0f-e84275ef19e8",
"db_language_id": "ee9ca2ee-2dfc-494c-aef9-c3b772401338",
"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-12-23T09:40:58.7621075+00:00"
},
"modified_dateutc": "2025-12-23T09:40:58.7621075+00:00"
},
"equipment_family_id": "6f4276ef-a4f5-431f-bd20-bd93b35b8467",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "92b5b24f-17f6-4177-a091-e67b9c880daf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e4d9b406-b7e0-432b-89b9-7f66b0881aff",
"_parent_code": "sample string 6",
"sales_organization_id": "108aeb9e-1256-4f46-a473-aade59abe5fa",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ca0772ee-9521-4bfe-89af-e7c115cc8bf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "58e54c6f-d4ca-41c0-8d3c-f6490b0e0e4a",
"db_currency_id": "987e89b9-429c-43b7-8f0f-e84275ef19e8",
"db_language_id": "ee9ca2ee-2dfc-494c-aef9-c3b772401338",
"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-12-23T09:40:58.7621075+00:00"
},
"modified_dateutc": "2025-12-23T09:40:58.7621075+00:00"
},
"date_in_production_since": "2025-12-23T09:40:58.7621075+00:00",
"date_out_of_production_since": "2025-12-23T09:40:58.7621075+00:00",
"date_end_support": "2025-12-23T09:40:58.7621075+00:00",
"sales_organization_id": "cce97b8e-1d57-4e0a-9f95-0b9f0dbd82bc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ca0772ee-9521-4bfe-89af-e7c115cc8bf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "58e54c6f-d4ca-41c0-8d3c-f6490b0e0e4a",
"db_currency_id": "987e89b9-429c-43b7-8f0f-e84275ef19e8",
"db_language_id": "ee9ca2ee-2dfc-494c-aef9-c3b772401338",
"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-12-23T09:40:58.7621075+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-12-23T09:40:58.7621075+00:00"
},
"project_status_id": "18c2bca2-8680-4692-bbef-d1151d2325cd",
"project_status_code": "sample string 10",
"project_status": {
"id": "c7c426f1-214a-4cee-ac0a-ccc561de0d35",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d86616d6-b5a6-4cd8-b496-ebb72fdb9192",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ca0772ee-9521-4bfe-89af-e7c115cc8bf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "58e54c6f-d4ca-41c0-8d3c-f6490b0e0e4a",
"db_currency_id": "987e89b9-429c-43b7-8f0f-e84275ef19e8",
"db_language_id": "ee9ca2ee-2dfc-494c-aef9-c3b772401338",
"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-12-23T09:40:58.7621075+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-23T09:40:58.7621075+00:00"
},
"company_id": "270e9df2-1e90-43da-9b10-6235dd9c4156",
"company_code": "sample string 12",
"db_address_id": "62cb920f-15e0-4423-be94-861261f841f4",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "edf7071f-c694-4f2b-95b2-a509d3061c45",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4a814209-1d49-485a-8140-1f5a51a951f6",
"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-12-23T09:40:58.7621075+00:00",
"date_create": "2025-12-23T09:40:58.7777316+00:00",
"date_update": "2025-12-23T09:40:58.7777316+00:00",
"updated_by_user_id": "ba1a58c2-b74f-4cea-8c37-4ec17f60d7c3",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-23T09:40:58.7777316+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-12-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-23T09:40:58.7777316+00:00",
"date_last_job": "2025-12-23T09:40:58.7777316+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-23T09:40:58.7777316+00:00",
"modified_dateutc": "2025-12-23T09:40:58.7777316+00:00",
"is_mobile_installation": true
},
"job_type_id": "1fd59489-67ce-437d-8a55-4923639d1208",
"job_type_code": "sample string 7",
"job_type": {
"id": "a2263558-e2ee-4e0c-b6ad-caa135dae1db",
"name": "sample string 2",
"sales_organization_id": "c921b203-259a-49bf-bf12-12e4e0f3d1ee",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-23T09:40:58.7777316+00:00",
"code": "sample string 7"
},
"job_priority_id": "cc77d8df-6f39-4adf-9f87-2773c392329d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "99b1400f-253a-4b59-93ca-094e53e61a9b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "baa4ee0b-b0a0-48b9-93ab-93f54e4dcdb7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ca0772ee-9521-4bfe-89af-e7c115cc8bf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "58e54c6f-d4ca-41c0-8d3c-f6490b0e0e4a",
"db_currency_id": "987e89b9-429c-43b7-8f0f-e84275ef19e8",
"db_language_id": "ee9ca2ee-2dfc-494c-aef9-c3b772401338",
"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-12-23T09:40:58.7621075+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-23T09:40:58.7777316+00:00"
},
"job_status_id": "9c324ef4-823f-460a-a300-6dda31921de4",
"job_status_code": "sample string 11",
"db_address_id": "05f49d30-64f5-41c6-931d-6c02f2ab4676",
"contact_id": "a82a8fd7-7d9d-4fdb-82af-7d1212cc5c4c",
"requested_by_company_id": "7c1f05be-2b9c-4e0f-b4b2-8608843f7be1",
"requested_by_contact_id": "65a139fa-cf14-455c-82e3-d49dd6ee3f1c",
"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-12-23T09:40:58.7777316+00:00",
"due_date": "2025-12-23T09:40:58.7777316+00:00",
"date_create": "2025-12-23T09:40:58.7777316+00:00",
"date_update": "2025-12-23T09:40:58.7777316+00:00",
"date_closed": "2025-12-23T09:40:58.7777316+00:00",
"suggested_user_id": "71a6b888-96c9-42f8-ae5b-398a50e75615",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2b3de753-2c6d-4f18-a03a-184280f30858",
"db_language_id": "34837b93-1a08-4cbe-975f-428db5eacb4b",
"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-12-23T09:40:58.7777316+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8a2d9eae-2a6a-405b-b56a-5c02c85c3941",
"sales_organization": {
"id": "ca0772ee-9521-4bfe-89af-e7c115cc8bf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "58e54c6f-d4ca-41c0-8d3c-f6490b0e0e4a",
"db_currency_id": "987e89b9-429c-43b7-8f0f-e84275ef19e8",
"db_language_id": "ee9ca2ee-2dfc-494c-aef9-c3b772401338",
"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-12-23T09:40:58.7621075+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4d5bed86-6f15-4f12-92ea-9ce04877ee9c",
"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": "63905551-e7c3-48fb-b66f-d09b5a6f55a3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-23T09:40:58.7777316+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ab446086-62a1-49bf-92fb-a0380c428b24"
},
"suggested_date_start": "2025-12-23T09:40:58.7777316+00:00",
"skill_id": "d87413b4-2749-4353-9858-0bf7db390904",
"skill_code": "sample string 32",
"skill": {
"id": "c0207443-c3eb-41ce-af4d-3202d5ab2bc9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "87e7b95c-6773-4224-84dc-68126bbc4383",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ca0772ee-9521-4bfe-89af-e7c115cc8bf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "58e54c6f-d4ca-41c0-8d3c-f6490b0e0e4a",
"db_currency_id": "987e89b9-429c-43b7-8f0f-e84275ef19e8",
"db_language_id": "ee9ca2ee-2dfc-494c-aef9-c3b772401338",
"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-12-23T09:40:58.7621075+00:00"
},
"modified_dateutc": "2025-12-23T09:40:58.7777316+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3b055ede-3345-4c54-a604-b34910b7b289",
"date_reported_by_company": "2025-12-23T09:40:58.7777316+00:00",
"id2": 36,
"company_id": "7c04b7be-9ee3-4f91-b57e-46a83f806f16",
"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": "24b7bd92-1030-4b6f-9fc1-43c09a17c223",
"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-12-23T09:40:58.7777316+00:00"
},
"work_instruction_details_id": "207c56b0-8973-485d-a072-0d0d9ee4a0ea",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "095ca6fc-40e5-4f89-8cec-f58e82cad28e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "64f8662e-e37d-44a5-8bdd-5d3791f2ba9b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-23T09:40:58.7777316+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": "ed7b296c-c61f-449b-b2c0-60c792434f57",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-23T09:40:58.7777316+00:00"
}