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": "0ad15b80-d26c-46b0-8517-8780c1946fa6",
"jobs_id": "f60e5a5a-6ff5-445f-9847-f48f24926f57",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "51994010-74f3-43e9-83fa-e4192f8acb38",
"_parent_id": "195047f1-2b9a-454b-b2b7-2b36667d179d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c32e3990-9999-4760-b37d-dfab324ae86f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e42d7e3f-afa4-40d2-acb8-81173b2c4ffc",
"_parent_id": "a54e4624-46d6-4f7e-b8f4-1984d4b721f3",
"root_parent_id": "5435f9b5-663b-465d-bb94-b6c9bfafc6e3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7a71d10f-3aed-4d57-b392-3474b221225b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7af90136-1c21-4d76-aee5-15199c99bba6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d4ac0bcc-05df-42fa-a068-9860fbed34e6",
"_parent_code": "sample string 6",
"sales_organization_id": "55baf7e9-5565-4837-89a8-46f1a2ba0287",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "aac36779-9e23-44af-9cb7-8e970cc83d71",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "91229a50-8aa2-4b2e-aa57-1da6e7a88cbe",
"db_currency_id": "f7387175-53a1-4de3-a06f-d718b66ba960",
"db_language_id": "7c78cb91-3455-4bec-adf3-eb447562b296",
"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-18T07:03:31.0536401+00:00"
},
"modified_dateutc": "2026-02-18T07:03:31.0536401+00:00"
},
"equipment_model_id": "c4281862-a321-4bcf-9f06-baca6962697f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2368ef8c-4abf-48cb-9552-31e19dd72e00",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "021b07b4-c78e-4f65-972b-296c0211c5a2",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6965264f-a81e-4b54-abe4-d1f9f0b40b64",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8d0bf81e-d9f1-4fd4-81e9-73e3c3822dc0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "aac36779-9e23-44af-9cb7-8e970cc83d71",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "91229a50-8aa2-4b2e-aa57-1da6e7a88cbe",
"db_currency_id": "f7387175-53a1-4de3-a06f-d718b66ba960",
"db_language_id": "7c78cb91-3455-4bec-adf3-eb447562b296",
"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-18T07:03:31.0536401+00:00"
},
"modified_dateutc": "2026-02-18T07:03:31.0536401+00:00"
},
"equipment_family_id": "6629c66b-f604-409e-81f3-bb24afdeb25c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7af90136-1c21-4d76-aee5-15199c99bba6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d4ac0bcc-05df-42fa-a068-9860fbed34e6",
"_parent_code": "sample string 6",
"sales_organization_id": "55baf7e9-5565-4837-89a8-46f1a2ba0287",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "aac36779-9e23-44af-9cb7-8e970cc83d71",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "91229a50-8aa2-4b2e-aa57-1da6e7a88cbe",
"db_currency_id": "f7387175-53a1-4de3-a06f-d718b66ba960",
"db_language_id": "7c78cb91-3455-4bec-adf3-eb447562b296",
"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-18T07:03:31.0536401+00:00"
},
"modified_dateutc": "2026-02-18T07:03:31.0536401+00:00"
},
"date_in_production_since": "2026-02-18T07:03:31.0536401+00:00",
"date_out_of_production_since": "2026-02-18T07:03:31.0536401+00:00",
"date_end_support": "2026-02-18T07:03:31.0536401+00:00",
"sales_organization_id": "072ca989-530c-46f4-a321-d0f8a4bf2ff0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "aac36779-9e23-44af-9cb7-8e970cc83d71",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "91229a50-8aa2-4b2e-aa57-1da6e7a88cbe",
"db_currency_id": "f7387175-53a1-4de3-a06f-d718b66ba960",
"db_language_id": "7c78cb91-3455-4bec-adf3-eb447562b296",
"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-18T07:03:31.0536401+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-18T07:03:31.0536401+00:00"
},
"project_status_id": "9d8a4b77-a3b8-4433-9d47-db206e0a605f",
"project_status_code": "sample string 10",
"project_status": {
"id": "c7e1bc06-e601-4a7a-b71b-7a8eb07f49a5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "58bb334d-f81f-4fe9-818f-1b8ec38ee283",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aac36779-9e23-44af-9cb7-8e970cc83d71",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "91229a50-8aa2-4b2e-aa57-1da6e7a88cbe",
"db_currency_id": "f7387175-53a1-4de3-a06f-d718b66ba960",
"db_language_id": "7c78cb91-3455-4bec-adf3-eb447562b296",
"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-18T07:03:31.0536401+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-18T07:03:31.0536401+00:00"
},
"company_id": "c5c9ff99-b7fc-4d56-adb8-d17b015fd1e3",
"company_code": "sample string 12",
"db_address_id": "e47c8e9d-d1f3-4c8c-957e-bdff3dfe675f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e6cf7a30-ae66-4770-ac87-fe05415714f0",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ac95cce3-1a64-4aaa-a36b-8e8a16bcd755",
"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-18T07:03:31.0536401+00:00",
"date_create": "2026-02-18T07:03:31.0536401+00:00",
"date_update": "2026-02-18T07:03:31.0536401+00:00",
"updated_by_user_id": "d66e3367-89e8-4d0c-92cb-aea462fa30d3",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-18T07:03:31.0536401+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-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-18T07:03:31.0536401+00:00",
"date_last_job": "2026-02-18T07:03:31.0536401+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-18T07:03:31.0536401+00:00",
"modified_dateutc": "2026-02-18T07:03:31.0536401+00:00",
"is_mobile_installation": true
},
"job_type_id": "22719fd5-4365-4bf2-bcd4-96af68df8b75",
"job_type_code": "sample string 7",
"job_type": {
"id": "f3de8034-2147-437f-8b8e-b373bafa3b11",
"name": "sample string 2",
"sales_organization_id": "a70ab659-4496-42df-9093-914585e4ea7e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-18T07:03:31.0536401+00:00",
"code": "sample string 7"
},
"job_priority_id": "1d3fd29a-f4f7-4e1e-a4d7-d22016628d09",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8e3097a7-d1c5-47f7-a4a0-b87e7e8c8c88",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8c3bd3a1-e087-4ef7-9c3a-96aad6f56a43",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aac36779-9e23-44af-9cb7-8e970cc83d71",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "91229a50-8aa2-4b2e-aa57-1da6e7a88cbe",
"db_currency_id": "f7387175-53a1-4de3-a06f-d718b66ba960",
"db_language_id": "7c78cb91-3455-4bec-adf3-eb447562b296",
"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-18T07:03:31.0536401+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-18T07:03:31.0536401+00:00"
},
"job_status_id": "96e20f18-a26e-4f95-b73b-d2992206d193",
"job_status_code": "sample string 11",
"db_address_id": "6bfde679-3e93-4962-8732-fef926dff8c0",
"contact_id": "c730ea0c-4224-4b62-8628-0a952690346a",
"requested_by_company_id": "6a785149-23a8-4107-80d6-5c93b72bf994",
"requested_by_contact_id": "a280e20e-8281-4007-b117-118317a2ca1b",
"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-18T07:03:31.0536401+00:00",
"due_date": "2026-02-18T07:03:31.0536401+00:00",
"date_create": "2026-02-18T07:03:31.0536401+00:00",
"date_update": "2026-02-18T07:03:31.0536401+00:00",
"date_closed": "2026-02-18T07:03:31.0536401+00:00",
"suggested_user_id": "45a806ab-28a5-4af9-81fd-64c11210a1d9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "cd9f90d9-2ecd-4760-92dd-068b31acdc97",
"db_language_id": "877dfac7-0f32-4d3e-9c27-1519cc8e0ce5",
"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-18T07:03:31.0536401+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f9fea505-f632-4b2f-960a-bddc3684c266",
"sales_organization": {
"id": "aac36779-9e23-44af-9cb7-8e970cc83d71",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "91229a50-8aa2-4b2e-aa57-1da6e7a88cbe",
"db_currency_id": "f7387175-53a1-4de3-a06f-d718b66ba960",
"db_language_id": "7c78cb91-3455-4bec-adf3-eb447562b296",
"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-18T07:03:31.0536401+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "190a1b8b-400a-4f90-bc3c-21dab2647a0f",
"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": "2a300c5c-bdc4-4b35-9e59-08a1db5aa232",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-18T07:03:31.0536401+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "65977a23-b8e6-4f17-b759-9dc12824dd82"
},
"suggested_date_start": "2026-02-18T07:03:31.0536401+00:00",
"skill_id": "af7a2fcc-7b96-4579-b647-1efe4c2ba93a",
"skill_code": "sample string 32",
"skill": {
"id": "3aa8d621-553f-4a82-bfaf-9da332002442",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "30505ddd-5c47-437d-9887-34ff125e5392",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aac36779-9e23-44af-9cb7-8e970cc83d71",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "91229a50-8aa2-4b2e-aa57-1da6e7a88cbe",
"db_currency_id": "f7387175-53a1-4de3-a06f-d718b66ba960",
"db_language_id": "7c78cb91-3455-4bec-adf3-eb447562b296",
"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-18T07:03:31.0536401+00:00"
},
"modified_dateutc": "2026-02-18T07:03:31.0536401+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ca15b876-c7c2-40f9-8efe-4dbc6cc7b581",
"date_reported_by_company": "2026-02-18T07:03:31.0536401+00:00",
"id2": 36,
"company_id": "aac76ff4-348a-4b17-962f-634344274468",
"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": "afe3a197-9938-483f-89b8-b2e868bf3753",
"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-18T07:03:31.0536401+00:00"
},
"work_instruction_details_id": "1b32eaf2-dcdc-4986-ba0c-eaba254b3fd8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "659920e0-37ae-4eb2-abcf-8a53c4c9d3e9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "eae1e520-daaa-4292-b5bb-aead7c039d0f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-18T07:03:31.0536401+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": "c04fff1e-bed4-4bf4-a682-9865c87f97e3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-18T07:03:31.0536401+00:00"
}