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": "13b95e85-fcec-438a-9c47-5d7bd7d8a26a",
"jobs_id": "b06dfcd2-19c9-4d6d-8566-07b871934178",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "72ea98eb-8fe6-4f40-982b-bf0b94b32145",
"_parent_id": "4f7936c0-e7e5-4fa6-b06d-5f4a994b1c95",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b706f5cc-aa3e-4242-92aa-fcf6487f7354",
"project_reference_back_office": "sample string 5",
"project": {
"id": "23b46d6b-dfa3-4db0-9dee-87726d0fade4",
"_parent_id": "7a3bbf1e-3025-46d5-ab5c-c5c148236bb7",
"root_parent_id": "0ad6cd8f-5362-4764-a496-8e7e9ca7e7ac",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6fdf38b1-a164-4d4c-91cb-8cfe757b5adf",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "33e28187-1f89-4d36-b221-e1e3a1feb667",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "913f5875-6e86-4762-8f08-cd483a1d0cb3",
"_parent_code": "sample string 6",
"sales_organization_id": "e8c267d7-b631-4f3f-9dd3-f7b800acb6ab",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4f12beb9-5bf0-40a3-96b6-647167ace24f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6a2cea87-ad96-4707-9fad-d0001afdae9c",
"db_currency_id": "0c6e07b2-5e18-44b2-88b7-4509f1a94c98",
"db_language_id": "b8ef77b8-674f-44f9-9f15-4ad21642fe5d",
"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-02-10T06:50:22.713497+00:00"
},
"modified_dateutc": "2026-02-10T06:50:22.713497+00:00"
},
"equipment_model_id": "931d39e0-acb3-4e77-afbb-89f876ef1134",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d67b9c7a-177b-4a0d-970f-ab46371d111f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "bad5ec03-19ad-4862-be53-fa16b774daad",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e13bfeb1-e947-46bb-abfa-b577d2e75de5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "bd0a2063-cc96-439d-a1dd-7c8b63a70107",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4f12beb9-5bf0-40a3-96b6-647167ace24f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6a2cea87-ad96-4707-9fad-d0001afdae9c",
"db_currency_id": "0c6e07b2-5e18-44b2-88b7-4509f1a94c98",
"db_language_id": "b8ef77b8-674f-44f9-9f15-4ad21642fe5d",
"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-02-10T06:50:22.713497+00:00"
},
"modified_dateutc": "2026-02-10T06:50:22.713497+00:00"
},
"equipment_family_id": "df05bee8-0861-4634-82fd-9abc20f184d6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "33e28187-1f89-4d36-b221-e1e3a1feb667",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "913f5875-6e86-4762-8f08-cd483a1d0cb3",
"_parent_code": "sample string 6",
"sales_organization_id": "e8c267d7-b631-4f3f-9dd3-f7b800acb6ab",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4f12beb9-5bf0-40a3-96b6-647167ace24f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6a2cea87-ad96-4707-9fad-d0001afdae9c",
"db_currency_id": "0c6e07b2-5e18-44b2-88b7-4509f1a94c98",
"db_language_id": "b8ef77b8-674f-44f9-9f15-4ad21642fe5d",
"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-02-10T06:50:22.713497+00:00"
},
"modified_dateutc": "2026-02-10T06:50:22.713497+00:00"
},
"date_in_production_since": "2026-02-10T06:50:22.713497+00:00",
"date_out_of_production_since": "2026-02-10T06:50:22.713497+00:00",
"date_end_support": "2026-02-10T06:50:22.713497+00:00",
"sales_organization_id": "53f8f457-e81d-4f92-8d67-1702530cc568",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4f12beb9-5bf0-40a3-96b6-647167ace24f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6a2cea87-ad96-4707-9fad-d0001afdae9c",
"db_currency_id": "0c6e07b2-5e18-44b2-88b7-4509f1a94c98",
"db_language_id": "b8ef77b8-674f-44f9-9f15-4ad21642fe5d",
"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-02-10T06:50:22.713497+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-02-10T06:50:22.713497+00:00"
},
"project_status_id": "81063a9a-7e7e-4b64-902c-c62ab527865f",
"project_status_code": "sample string 10",
"project_status": {
"id": "aa799ddc-a6b4-4f8c-aa8b-8487e534c6b1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f0b22180-6367-4f5d-bf7b-4e1430fbc00b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4f12beb9-5bf0-40a3-96b6-647167ace24f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6a2cea87-ad96-4707-9fad-d0001afdae9c",
"db_currency_id": "0c6e07b2-5e18-44b2-88b7-4509f1a94c98",
"db_language_id": "b8ef77b8-674f-44f9-9f15-4ad21642fe5d",
"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-02-10T06:50:22.713497+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-10T06:50:22.713497+00:00"
},
"company_id": "e2159d94-cfb5-4302-bd36-df100a2bd8cf",
"company_code": "sample string 12",
"db_address_id": "542d4e50-48d5-4913-817e-09ad2fa37229",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7c4984a5-8b65-43ff-9291-c13335743450",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c9324855-04eb-495d-8b02-241282ce6d5a",
"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-02-10T06:50:22.713497+00:00",
"date_create": "2026-02-10T06:50:22.713497+00:00",
"date_update": "2026-02-10T06:50:22.713497+00:00",
"updated_by_user_id": "239de898-740f-41c4-9a73-8e3001b75ba1",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-10T06:50:22.713497+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-02-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-10T06:50:22.713497+00:00",
"date_last_job": "2026-02-10T06:50:22.713497+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-10T06:50:22.713497+00:00",
"modified_dateutc": "2026-02-10T06:50:22.713497+00:00",
"is_mobile_installation": true
},
"job_type_id": "b561f049-e83b-4384-b1e4-57bd686140be",
"job_type_code": "sample string 7",
"job_type": {
"id": "2532e14e-8dc8-43b1-9c93-d8ad93d9b8e4",
"name": "sample string 2",
"sales_organization_id": "6f1260ec-a932-418a-b430-9f0a829b2004",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-10T06:50:22.713497+00:00",
"code": "sample string 7"
},
"job_priority_id": "97be1023-296a-4ccd-b23b-02729aff04f1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ddcac4b3-d02f-4eff-939f-994fd5499d32",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d19383a5-d877-4721-b362-2cc02b0a473b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4f12beb9-5bf0-40a3-96b6-647167ace24f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6a2cea87-ad96-4707-9fad-d0001afdae9c",
"db_currency_id": "0c6e07b2-5e18-44b2-88b7-4509f1a94c98",
"db_language_id": "b8ef77b8-674f-44f9-9f15-4ad21642fe5d",
"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-02-10T06:50:22.713497+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-10T06:50:22.713497+00:00"
},
"job_status_id": "4f8138fe-c001-47ec-b975-1d54210ec3ea",
"job_status_code": "sample string 11",
"db_address_id": "c5581ecc-4d16-4515-bd2b-0968998ad89b",
"contact_id": "686ed9ce-69da-4be5-a052-11ffcb9298a5",
"requested_by_company_id": "abcd25e2-033f-43c4-ad4d-89703b246d8b",
"requested_by_contact_id": "d3bd356b-212c-4f52-bc6b-85b6b54858a9",
"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-02-10T06:50:22.713497+00:00",
"due_date": "2026-02-10T06:50:22.713497+00:00",
"date_create": "2026-02-10T06:50:22.713497+00:00",
"date_update": "2026-02-10T06:50:22.713497+00:00",
"date_closed": "2026-02-10T06:50:22.713497+00:00",
"suggested_user_id": "2e734fab-ac65-4e27-8e05-230dfd8bb0d7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "44660642-6342-4960-a924-5bff16c765c5",
"db_language_id": "254e48e4-e92c-4a4b-a703-42b98a20b08f",
"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-02-10T06:50:22.713497+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "12d82487-9726-4fb8-902d-58792ef0fb1f",
"sales_organization": {
"id": "4f12beb9-5bf0-40a3-96b6-647167ace24f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6a2cea87-ad96-4707-9fad-d0001afdae9c",
"db_currency_id": "0c6e07b2-5e18-44b2-88b7-4509f1a94c98",
"db_language_id": "b8ef77b8-674f-44f9-9f15-4ad21642fe5d",
"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-02-10T06:50:22.713497+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "28c2cac1-6000-4184-9691-ea5999c8ff18",
"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": "1483e5bb-72e0-47a7-bf7c-4a2a7fa06372",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-10T06:50:22.713497+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "73fd2e42-2f14-4f0f-a7e4-67d18277c302"
},
"suggested_date_start": "2026-02-10T06:50:22.713497+00:00",
"skill_id": "25c118cf-a7eb-463c-8c82-f6ebe3e43bd7",
"skill_code": "sample string 32",
"skill": {
"id": "469315f8-ba39-492c-b91c-8ae7b8923e90",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b6fd713a-857e-404b-849d-7dc1d3e6cca1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4f12beb9-5bf0-40a3-96b6-647167ace24f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6a2cea87-ad96-4707-9fad-d0001afdae9c",
"db_currency_id": "0c6e07b2-5e18-44b2-88b7-4509f1a94c98",
"db_language_id": "b8ef77b8-674f-44f9-9f15-4ad21642fe5d",
"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-02-10T06:50:22.713497+00:00"
},
"modified_dateutc": "2026-02-10T06:50:22.713497+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a0fd96d3-2c7e-4575-a491-70fc29b850a0",
"date_reported_by_company": "2026-02-10T06:50:22.713497+00:00",
"id2": 36,
"company_id": "c2d1c8e6-bf7f-466d-b05c-f50b82efb576",
"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": "bdee35bd-ec0f-4668-a55a-390b23e122ad",
"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-02-10T06:50:22.713497+00:00"
},
"work_instruction_details_id": "27a50985-3054-44ac-8876-e4cfc4e66c2a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "130f303a-1db9-47ea-b311-b27dfdaf9d40",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1c3bd599-b3b3-4e9b-ba9a-290f9009e81d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-10T06:50:22.713497+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": "4dd12613-1530-4ede-8879-2ce4158527b9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-10T06:50:22.713497+00:00"
}