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": "b2f736ce-1caf-40c4-bafd-844a7f34e046",
"jobs_id": "81180795-cf02-404a-ba47-9f2ee58eed23",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "13825925-4b34-41b0-ad39-2da0e945d806",
"_parent_id": "682ee565-5c6a-4a1c-9c2f-0186c030c1c4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1b5b1a00-2952-4158-973e-bff6ddb7fedf",
"project_reference_back_office": "sample string 5",
"project": {
"id": "be53724d-60ed-4c2b-9cf8-2ab50c541ece",
"_parent_id": "f4eebd83-08c9-4324-8af7-f0fa32bafe2b",
"root_parent_id": "be1ff00a-4821-45ae-92fb-a4a2c60383e8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "06e5562f-77fe-454b-b4f4-23d713525743",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "da20e1f5-d272-4cfd-8e04-49248739d8cc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2267df67-93f0-40f9-ae03-ed63710dacc9",
"_parent_code": "sample string 6",
"sales_organization_id": "dce301f4-c70e-4332-824b-fed6feedc114",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c28cd103-5dc0-49c5-96fb-395b5b877449",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4755ad8-7159-49f9-b2b7-0e44065992ee",
"db_currency_id": "81890bb0-da0b-4a6d-824e-fe0c8c459a09",
"db_language_id": "d8641c33-80b0-4aff-ad91-96d1ad7ee38d",
"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-08-23T17:01:33.9919487+00:00"
},
"modified_dateutc": "2026-08-23T17:01:33.9919487+00:00"
},
"equipment_model_id": "15708d31-9529-4c9e-b7c0-5e89501785b8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a4da4790-46bb-4419-9778-411e1b3bc8b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ee0069de-122f-4d46-8602-c7e5134b9473",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7787b93a-94d6-4ff5-8941-f6c2a3fa11f2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e3e0528d-e941-4e39-94f4-1c3ce3f4c0c5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c28cd103-5dc0-49c5-96fb-395b5b877449",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4755ad8-7159-49f9-b2b7-0e44065992ee",
"db_currency_id": "81890bb0-da0b-4a6d-824e-fe0c8c459a09",
"db_language_id": "d8641c33-80b0-4aff-ad91-96d1ad7ee38d",
"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-08-23T17:01:33.9919487+00:00"
},
"modified_dateutc": "2026-08-23T17:01:33.9919487+00:00"
},
"equipment_family_id": "3ccb664f-ad3d-472a-aceb-7f5b443a572e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "da20e1f5-d272-4cfd-8e04-49248739d8cc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2267df67-93f0-40f9-ae03-ed63710dacc9",
"_parent_code": "sample string 6",
"sales_organization_id": "dce301f4-c70e-4332-824b-fed6feedc114",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c28cd103-5dc0-49c5-96fb-395b5b877449",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4755ad8-7159-49f9-b2b7-0e44065992ee",
"db_currency_id": "81890bb0-da0b-4a6d-824e-fe0c8c459a09",
"db_language_id": "d8641c33-80b0-4aff-ad91-96d1ad7ee38d",
"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-08-23T17:01:33.9919487+00:00"
},
"modified_dateutc": "2026-08-23T17:01:33.9919487+00:00"
},
"date_in_production_since": "2026-08-23T17:01:33.9919487+00:00",
"date_out_of_production_since": "2026-08-23T17:01:33.9919487+00:00",
"date_end_support": "2026-08-23T17:01:33.9919487+00:00",
"sales_organization_id": "908bdd72-d2a9-486c-b9cb-fd0bc4309f02",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c28cd103-5dc0-49c5-96fb-395b5b877449",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4755ad8-7159-49f9-b2b7-0e44065992ee",
"db_currency_id": "81890bb0-da0b-4a6d-824e-fe0c8c459a09",
"db_language_id": "d8641c33-80b0-4aff-ad91-96d1ad7ee38d",
"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-08-23T17:01:33.9919487+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-08-23T17:01:33.9919487+00:00"
},
"project_status_id": "dd83e118-99b2-4184-92bb-84f6011f7dfb",
"project_status_code": "sample string 10",
"project_status": {
"id": "e10f2d74-3a43-4544-92e6-c2e0bee19f36",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f427931f-7ddf-437c-b022-57185b661ede",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c28cd103-5dc0-49c5-96fb-395b5b877449",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4755ad8-7159-49f9-b2b7-0e44065992ee",
"db_currency_id": "81890bb0-da0b-4a6d-824e-fe0c8c459a09",
"db_language_id": "d8641c33-80b0-4aff-ad91-96d1ad7ee38d",
"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-08-23T17:01:33.9919487+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-23T17:01:34.0075705+00:00"
},
"company_id": "fab0bd9e-1144-4c14-8e2c-845574647638",
"company_code": "sample string 12",
"db_address_id": "e528b7fd-ec7b-46b1-899d-593cb44e0c48",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "91a32920-94e9-4428-9af0-e0bab8e55d78",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9d070afe-af25-48c4-a53a-3566a641a2a2",
"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-08-23T17:01:34.0075705+00:00",
"date_create": "2026-08-23T17:01:34.0075705+00:00",
"date_update": "2026-08-23T17:01:34.0075705+00:00",
"updated_by_user_id": "d5c889d0-cf3e-413b-b2f5-4c1b1d1af141",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-23T17:01:34.0075705+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-08-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-23T17:01:34.0075705+00:00",
"date_last_job": "2026-08-23T17:01:34.0075705+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-23T17:01:34.0075705+00:00",
"modified_dateutc": "2026-08-23T17:01:34.0075705+00:00",
"is_mobile_installation": true
},
"job_type_id": "b73d8261-def7-45a7-b7d4-5dee3d1e58e3",
"job_type_code": "sample string 7",
"job_type": {
"id": "b81e7bad-a29d-4f7d-8a89-ab22404fb65a",
"name": "sample string 2",
"sales_organization_id": "905e3b21-f748-4340-b094-c240d2e7f681",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-23T17:01:34.0075705+00:00",
"code": "sample string 7"
},
"job_priority_id": "014c45ee-2f1a-4706-a882-da49bf2629ce",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9fa87bc8-d831-420f-a161-0bcaac80ba0c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "86e71a12-111a-4fc1-9636-ef46b75b2d24",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c28cd103-5dc0-49c5-96fb-395b5b877449",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4755ad8-7159-49f9-b2b7-0e44065992ee",
"db_currency_id": "81890bb0-da0b-4a6d-824e-fe0c8c459a09",
"db_language_id": "d8641c33-80b0-4aff-ad91-96d1ad7ee38d",
"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-08-23T17:01:33.9919487+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-23T17:01:34.0075705+00:00"
},
"job_status_id": "db403576-1d53-47b7-8bd7-9fb7f36ee6db",
"job_status_code": "sample string 11",
"db_address_id": "099056de-912d-4816-93cf-698ab05affc3",
"contact_id": "b94bd916-c925-495f-9b72-99381a1818fc",
"requested_by_company_id": "b299f819-593a-47b6-ada5-355282c595bc",
"requested_by_contact_id": "85da875b-bd38-4c5e-a46a-29f64b2369a3",
"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-08-23T17:01:34.0075705+00:00",
"due_date": "2026-08-23T17:01:34.0075705+00:00",
"date_create": "2026-08-23T17:01:34.0075705+00:00",
"date_update": "2026-08-23T17:01:34.0075705+00:00",
"date_closed": "2026-08-23T17:01:34.0075705+00:00",
"suggested_user_id": "ae0b2c38-e76a-494b-8f90-949a3ecef823",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8d539041-a817-4cff-b815-17c583f4342f",
"db_language_id": "86ae5027-e4f1-460c-9c1f-7234818953a9",
"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-08-23T17:01:34.0075705+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9a95056e-1390-4c75-9f6f-2338f6f52693",
"sales_organization": {
"id": "c28cd103-5dc0-49c5-96fb-395b5b877449",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4755ad8-7159-49f9-b2b7-0e44065992ee",
"db_currency_id": "81890bb0-da0b-4a6d-824e-fe0c8c459a09",
"db_language_id": "d8641c33-80b0-4aff-ad91-96d1ad7ee38d",
"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-08-23T17:01:33.9919487+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "062d3006-030c-4131-a90f-002815976655",
"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": "4b0d0222-bac2-4443-b0f8-e8b969a13b6c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-23T17:01:34.0075705+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9709d3ce-bd18-4239-aadf-5719850c968e"
},
"suggested_date_start": "2026-08-23T17:01:34.0075705+00:00",
"skill_id": "90f3ba33-8898-4992-820e-199190e7ac72",
"skill_code": "sample string 32",
"skill": {
"id": "91aea83a-4b78-4c91-9ab5-2ce2e0de9469",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f3448c9f-bfda-465d-bfd3-d0006680d140",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c28cd103-5dc0-49c5-96fb-395b5b877449",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4755ad8-7159-49f9-b2b7-0e44065992ee",
"db_currency_id": "81890bb0-da0b-4a6d-824e-fe0c8c459a09",
"db_language_id": "d8641c33-80b0-4aff-ad91-96d1ad7ee38d",
"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-08-23T17:01:33.9919487+00:00"
},
"modified_dateutc": "2026-08-23T17:01:34.0075705+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2709547d-730b-4b2c-8c45-4f6a7ae1c733",
"date_reported_by_company": "2026-08-23T17:01:34.0075705+00:00",
"id2": 36,
"company_id": "54419b05-d7f4-4066-bf87-7971a01d9a83",
"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": "e9ea1e6c-4322-480d-b80d-981a6a59c786",
"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-08-23T17:01:34.0075705+00:00"
},
"work_instruction_details_id": "bed0b020-2609-437f-83d7-f5772bef4cf7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8ea289a0-0fea-491e-aa8b-b0d1636b71a0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f68c335a-509e-4c0a-9282-ad0c37f7ab74",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-23T17:01:34.0075705+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": "c5615c5f-319c-4b5f-a477-16e8c8630faf",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-23T17:01:34.0075705+00:00"
}