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": "de2fbd3d-816c-494f-b363-169bd5b66525",
"jobs_id": "d8ae7391-f2ed-44ad-b3be-341959fc0487",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c274c60c-27ef-4642-8d92-4bc471491639",
"_parent_id": "3d30d838-8590-42d8-8522-5fc2ef0fdd1f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e89aa63e-986a-462d-a7da-7853032c042e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c04e61cc-11e3-4051-84d4-4df8a2213bb3",
"_parent_id": "68f50655-6460-403f-87c5-0615bb5f1032",
"root_parent_id": "026ad220-e88f-424a-912b-f240de44683c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "074116d4-6379-4c2e-9b2e-8a818a18df84",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b1f7e56b-6e25-4398-86e0-8875fd03c997",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4814f029-ca03-4a3f-85f5-a706a5d24976",
"_parent_code": "sample string 6",
"sales_organization_id": "2cd126a0-32d7-49ae-a74e-5648cb62be3c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4a44ee8d-82fb-4dd1-8893-bcb0874564d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e3ea1c6-cefc-4b01-a01c-d38fd7e77d5f",
"db_currency_id": "37249a9b-528e-4302-b3e3-b64286dd983c",
"db_language_id": "ef528007-365b-4d36-96b8-be6dafcdb939",
"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-01-14T20:55:16.6127359+00:00"
},
"modified_dateutc": "2026-01-14T20:55:16.6127359+00:00"
},
"equipment_model_id": "5034476a-18d2-46a8-ad78-391a2ee0aa2c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2ced7f5f-26f9-4832-8bcb-b61f3e4452c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "09520ba5-e292-4cbf-8895-3205a7cd3dac",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7cf847b1-78b2-4ac8-99eb-722d816bb86e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c457b048-5aa6-4fc9-a15e-d2581ffc5622",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4a44ee8d-82fb-4dd1-8893-bcb0874564d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e3ea1c6-cefc-4b01-a01c-d38fd7e77d5f",
"db_currency_id": "37249a9b-528e-4302-b3e3-b64286dd983c",
"db_language_id": "ef528007-365b-4d36-96b8-be6dafcdb939",
"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-01-14T20:55:16.6127359+00:00"
},
"modified_dateutc": "2026-01-14T20:55:16.6127359+00:00"
},
"equipment_family_id": "7389eede-9edd-4579-ac1b-47ecdbbbde7d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b1f7e56b-6e25-4398-86e0-8875fd03c997",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4814f029-ca03-4a3f-85f5-a706a5d24976",
"_parent_code": "sample string 6",
"sales_organization_id": "2cd126a0-32d7-49ae-a74e-5648cb62be3c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4a44ee8d-82fb-4dd1-8893-bcb0874564d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e3ea1c6-cefc-4b01-a01c-d38fd7e77d5f",
"db_currency_id": "37249a9b-528e-4302-b3e3-b64286dd983c",
"db_language_id": "ef528007-365b-4d36-96b8-be6dafcdb939",
"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-01-14T20:55:16.6127359+00:00"
},
"modified_dateutc": "2026-01-14T20:55:16.6127359+00:00"
},
"date_in_production_since": "2026-01-14T20:55:16.6127359+00:00",
"date_out_of_production_since": "2026-01-14T20:55:16.6127359+00:00",
"date_end_support": "2026-01-14T20:55:16.6127359+00:00",
"sales_organization_id": "1bc63248-78c8-4851-8df1-6b984585470f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4a44ee8d-82fb-4dd1-8893-bcb0874564d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e3ea1c6-cefc-4b01-a01c-d38fd7e77d5f",
"db_currency_id": "37249a9b-528e-4302-b3e3-b64286dd983c",
"db_language_id": "ef528007-365b-4d36-96b8-be6dafcdb939",
"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-01-14T20:55:16.6127359+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-01-14T20:55:16.6127359+00:00"
},
"project_status_id": "7268fc9b-9937-4381-9d1c-3129916e8dc1",
"project_status_code": "sample string 10",
"project_status": {
"id": "d0f553be-ac8c-43be-bb9e-ea242d525ba4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f94f7335-d35b-4955-b109-79ee50771bdd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4a44ee8d-82fb-4dd1-8893-bcb0874564d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e3ea1c6-cefc-4b01-a01c-d38fd7e77d5f",
"db_currency_id": "37249a9b-528e-4302-b3e3-b64286dd983c",
"db_language_id": "ef528007-365b-4d36-96b8-be6dafcdb939",
"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-01-14T20:55:16.6127359+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-14T20:55:16.6127359+00:00"
},
"company_id": "11ff58ee-b7af-4472-bd48-b53474664d44",
"company_code": "sample string 12",
"db_address_id": "1cba1829-c5b1-4683-b796-f22a0d9957f2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e7d74a33-4eb0-4237-8174-83765a35894e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "94c90d5a-d103-40f2-9063-5aeee69c9be7",
"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-01-14T20:55:16.6127359+00:00",
"date_create": "2026-01-14T20:55:16.6127359+00:00",
"date_update": "2026-01-14T20:55:16.6127359+00:00",
"updated_by_user_id": "70e4d19e-71b7-4129-8e96-7659e2ff4987",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-14T20:55:16.6127359+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-01-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-14T20:55:16.6127359+00:00",
"date_last_job": "2026-01-14T20:55:16.6127359+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-14T20:55:16.6127359+00:00",
"modified_dateutc": "2026-01-14T20:55:16.6127359+00:00",
"is_mobile_installation": true
},
"job_type_id": "fcc5156a-6f5a-4822-ad40-7bc726df5ca8",
"job_type_code": "sample string 7",
"job_type": {
"id": "e5d0c213-752d-4209-9d21-b959e90c052b",
"name": "sample string 2",
"sales_organization_id": "1e2964c8-346d-40a7-9385-afdc1d798546",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-14T20:55:16.6127359+00:00",
"code": "sample string 7"
},
"job_priority_id": "ef7b2c45-f52e-482f-9ed3-8e8d7b75145f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "81e2e24c-8ae7-42af-8298-ab45e91b1007",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7251d9db-b0b2-4a4f-ad4f-27fc6a8e0673",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4a44ee8d-82fb-4dd1-8893-bcb0874564d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e3ea1c6-cefc-4b01-a01c-d38fd7e77d5f",
"db_currency_id": "37249a9b-528e-4302-b3e3-b64286dd983c",
"db_language_id": "ef528007-365b-4d36-96b8-be6dafcdb939",
"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-01-14T20:55:16.6127359+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-14T20:55:16.6127359+00:00"
},
"job_status_id": "18301047-1ded-44e4-9195-bf5a8efed08c",
"job_status_code": "sample string 11",
"db_address_id": "68eb0b5e-6cce-4662-a6b4-b7de5176acd4",
"contact_id": "587cf116-e7ed-4921-b423-d164d2b48c8e",
"requested_by_company_id": "7a3c413a-f28d-4a04-b9fa-57489b60e3bc",
"requested_by_contact_id": "1ef135ee-85a6-4b30-8a40-cad88d8e6dd4",
"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-01-14T20:55:16.6127359+00:00",
"due_date": "2026-01-14T20:55:16.6127359+00:00",
"date_create": "2026-01-14T20:55:16.6127359+00:00",
"date_update": "2026-01-14T20:55:16.6127359+00:00",
"date_closed": "2026-01-14T20:55:16.6127359+00:00",
"suggested_user_id": "de6c6ae7-d368-440d-8724-3b6ee12fe9e5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "16879c1b-dfc4-4ed4-bca0-74e25acbf14e",
"db_language_id": "8fcd4a84-4266-4aa6-bab6-bc826bd1b3a2",
"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-01-14T20:55:16.6283638+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ac11056c-4e3d-4b59-8f21-ddc7d40aa18f",
"sales_organization": {
"id": "4a44ee8d-82fb-4dd1-8893-bcb0874564d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e3ea1c6-cefc-4b01-a01c-d38fd7e77d5f",
"db_currency_id": "37249a9b-528e-4302-b3e3-b64286dd983c",
"db_language_id": "ef528007-365b-4d36-96b8-be6dafcdb939",
"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-01-14T20:55:16.6127359+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7c99dff7-ad42-4f2e-95c2-5687e02a1f73",
"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": "4acfc66f-d659-46fc-87a4-12a471877823",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-14T20:55:16.6283638+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ba091d86-d4bb-4789-9885-38ec44c043ed"
},
"suggested_date_start": "2026-01-14T20:55:16.6283638+00:00",
"skill_id": "6c539330-25be-475d-9461-8c474794608e",
"skill_code": "sample string 32",
"skill": {
"id": "e38aea94-d5da-48fb-8a73-2202e385089f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "cd83648c-c81a-4e25-93e0-c3d907a7f32f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4a44ee8d-82fb-4dd1-8893-bcb0874564d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e3ea1c6-cefc-4b01-a01c-d38fd7e77d5f",
"db_currency_id": "37249a9b-528e-4302-b3e3-b64286dd983c",
"db_language_id": "ef528007-365b-4d36-96b8-be6dafcdb939",
"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-01-14T20:55:16.6127359+00:00"
},
"modified_dateutc": "2026-01-14T20:55:16.6283638+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5e03f990-4370-4d1c-84c3-ca0fbada6fbb",
"date_reported_by_company": "2026-01-14T20:55:16.6283638+00:00",
"id2": 36,
"company_id": "56fa3a0a-99a4-42ef-86df-3bbd6dc0aaf8",
"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": "212afa22-2d0e-4261-b6b8-2fa86ff929ad",
"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-01-14T20:55:16.6283638+00:00"
},
"work_instruction_details_id": "d5183efb-44ce-4fe6-8437-d1473c5d39aa",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1638352e-0721-4958-bcdb-15ca3b4560aa",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "faeb0308-9b4b-4454-973e-f8908cebcef6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-14T20:55:16.6283638+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": "dd4134d5-94c4-4a54-820e-410254c4e113",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-14T20:55:16.6283638+00:00"
}