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": "bc3421cf-612e-4419-a62d-70759d36b94a",
"jobs_id": "983d3648-c1c6-440d-8432-3822e813a8c9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a6eadd74-50ba-40d0-8174-38a3715b0ae6",
"_parent_id": "b3efb589-9502-4d2d-adac-df7e6784b21c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "98f48921-9190-4618-8171-8a3ce53cb24f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8a363f6a-ec65-4307-acc0-c3140b918d70",
"_parent_id": "ebf35ebc-7b3e-499c-b1a1-c65b7b1b5893",
"root_parent_id": "57cb642f-cd5e-4247-a8f6-f0c6c04e9081",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "cd86a74f-2738-48ff-8dcd-9d7cbe609df9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8f6c3eff-b3d9-4c00-8d4d-b4888cd82325",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dda29b23-9c24-4d6a-919f-06f65d40afe6",
"_parent_code": "sample string 6",
"sales_organization_id": "d6016e68-767b-4357-9395-c829b29eefd1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "40583cdd-2179-4903-90a7-e60471fd6e5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1a2fead3-215a-490f-83de-6111ec17f029",
"db_currency_id": "87404f9c-354f-49a5-8602-3a717722ea5f",
"db_language_id": "14837d82-f8e5-447f-8bda-1f3fa945621b",
"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-16T09:10:17.3300693+00:00"
},
"modified_dateutc": "2026-02-16T09:10:17.3300693+00:00"
},
"equipment_model_id": "00447c52-2880-4f7d-9d21-50ec22219d6c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8137792b-9f01-423e-b7e7-7251a85f01be",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a2fc1aa6-b266-4b45-9be2-5c9b15144a15",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "dff05dee-867a-4bcc-9e02-9e02531ec4af",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "be8cf6f4-90cd-47a2-be3a-d652dbd5706e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "40583cdd-2179-4903-90a7-e60471fd6e5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1a2fead3-215a-490f-83de-6111ec17f029",
"db_currency_id": "87404f9c-354f-49a5-8602-3a717722ea5f",
"db_language_id": "14837d82-f8e5-447f-8bda-1f3fa945621b",
"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-16T09:10:17.3300693+00:00"
},
"modified_dateutc": "2026-02-16T09:10:17.3300693+00:00"
},
"equipment_family_id": "869847a5-faa6-4096-a5cc-2b4a7abbfe53",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8f6c3eff-b3d9-4c00-8d4d-b4888cd82325",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dda29b23-9c24-4d6a-919f-06f65d40afe6",
"_parent_code": "sample string 6",
"sales_organization_id": "d6016e68-767b-4357-9395-c829b29eefd1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "40583cdd-2179-4903-90a7-e60471fd6e5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1a2fead3-215a-490f-83de-6111ec17f029",
"db_currency_id": "87404f9c-354f-49a5-8602-3a717722ea5f",
"db_language_id": "14837d82-f8e5-447f-8bda-1f3fa945621b",
"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-16T09:10:17.3300693+00:00"
},
"modified_dateutc": "2026-02-16T09:10:17.3300693+00:00"
},
"date_in_production_since": "2026-02-16T09:10:17.3300693+00:00",
"date_out_of_production_since": "2026-02-16T09:10:17.3300693+00:00",
"date_end_support": "2026-02-16T09:10:17.3300693+00:00",
"sales_organization_id": "859b3299-52f8-4b47-a40d-8797a304e7e8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "40583cdd-2179-4903-90a7-e60471fd6e5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1a2fead3-215a-490f-83de-6111ec17f029",
"db_currency_id": "87404f9c-354f-49a5-8602-3a717722ea5f",
"db_language_id": "14837d82-f8e5-447f-8bda-1f3fa945621b",
"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-16T09:10:17.3300693+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-16T09:10:17.3300693+00:00"
},
"project_status_id": "389d94b9-4e08-4f05-bc00-c402ad712f2c",
"project_status_code": "sample string 10",
"project_status": {
"id": "1f031e16-32ec-43e4-b208-d9462b688215",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6c3c06e9-3f30-4005-8155-92cad1bb6ed7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "40583cdd-2179-4903-90a7-e60471fd6e5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1a2fead3-215a-490f-83de-6111ec17f029",
"db_currency_id": "87404f9c-354f-49a5-8602-3a717722ea5f",
"db_language_id": "14837d82-f8e5-447f-8bda-1f3fa945621b",
"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-16T09:10:17.3300693+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-16T09:10:17.3300693+00:00"
},
"company_id": "e883a200-3110-43c2-86a3-87b5182c96f8",
"company_code": "sample string 12",
"db_address_id": "17978e6f-7df4-422e-a952-5ccb0e180b99",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "86dab985-480f-4f0b-afd4-6aa7a70598a4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6d50bb87-7665-4705-8e9d-09f2e52633b5",
"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-16T09:10:17.3300693+00:00",
"date_create": "2026-02-16T09:10:17.3300693+00:00",
"date_update": "2026-02-16T09:10:17.3300693+00:00",
"updated_by_user_id": "0b389bd8-f9b7-4017-bc63-288817a20398",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-16T09:10:17.3300693+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-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-16T09:10:17.3300693+00:00",
"date_last_job": "2026-02-16T09:10:17.3300693+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-16T09:10:17.3300693+00:00",
"modified_dateutc": "2026-02-16T09:10:17.3300693+00:00",
"is_mobile_installation": true
},
"job_type_id": "e1a59fca-5c81-4f4a-9312-c22234e10055",
"job_type_code": "sample string 7",
"job_type": {
"id": "2b1dbad0-92e0-4768-a296-a08e8491e7b9",
"name": "sample string 2",
"sales_organization_id": "376733df-9a4e-4eb0-a196-2c00e033b4f8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-16T09:10:17.3300693+00:00",
"code": "sample string 7"
},
"job_priority_id": "c2bb7709-e7c2-426f-98d1-3f713b1e35a5",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b51c4474-4e2c-46a6-8121-e87d5792f41e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "dfa51511-d83f-41ae-a65f-36c3a4ebf2af",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "40583cdd-2179-4903-90a7-e60471fd6e5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1a2fead3-215a-490f-83de-6111ec17f029",
"db_currency_id": "87404f9c-354f-49a5-8602-3a717722ea5f",
"db_language_id": "14837d82-f8e5-447f-8bda-1f3fa945621b",
"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-16T09:10:17.3300693+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-16T09:10:17.3300693+00:00"
},
"job_status_id": "fdb3b9d0-0c8c-42b1-930b-ba01f6d5e352",
"job_status_code": "sample string 11",
"db_address_id": "2bf3625b-e7d0-4699-b59f-f2e912a918a9",
"contact_id": "b73fdb68-154e-46ff-b983-bd6766aa1e71",
"requested_by_company_id": "c29e9377-bdd2-4aa0-985a-c37674d70a67",
"requested_by_contact_id": "83d65a6a-66bf-4939-b28e-87c030639c0c",
"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-16T09:10:17.3300693+00:00",
"due_date": "2026-02-16T09:10:17.3300693+00:00",
"date_create": "2026-02-16T09:10:17.3300693+00:00",
"date_update": "2026-02-16T09:10:17.3300693+00:00",
"date_closed": "2026-02-16T09:10:17.3300693+00:00",
"suggested_user_id": "3498220c-3d36-4ed2-b858-94059cc15854",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "dce6a8ad-6fa1-417e-adb4-eaa17fb79012",
"db_language_id": "46baa8cb-8437-4387-9f7c-2a8866ad207f",
"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-16T09:10:17.3300693+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c6a8bc3a-1d2a-4afe-9cb9-d709cfed71a9",
"sales_organization": {
"id": "40583cdd-2179-4903-90a7-e60471fd6e5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1a2fead3-215a-490f-83de-6111ec17f029",
"db_currency_id": "87404f9c-354f-49a5-8602-3a717722ea5f",
"db_language_id": "14837d82-f8e5-447f-8bda-1f3fa945621b",
"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-16T09:10:17.3300693+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "350d01ac-3cb1-41d0-8b2a-2f62c427856c",
"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": "fe85226b-64f1-4d4c-a2bc-e67f90c0f108",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-16T09:10:17.3300693+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "575a2602-3005-40c2-9a42-e28c6e9c79a7"
},
"suggested_date_start": "2026-02-16T09:10:17.3300693+00:00",
"skill_id": "f99ff0cd-cce4-432f-a559-0fb91ff486ca",
"skill_code": "sample string 32",
"skill": {
"id": "1c9ea753-26ac-4c51-8319-0c55ee098832",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "23d4e022-b241-49e4-828e-f473b72b0e5e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "40583cdd-2179-4903-90a7-e60471fd6e5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1a2fead3-215a-490f-83de-6111ec17f029",
"db_currency_id": "87404f9c-354f-49a5-8602-3a717722ea5f",
"db_language_id": "14837d82-f8e5-447f-8bda-1f3fa945621b",
"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-16T09:10:17.3300693+00:00"
},
"modified_dateutc": "2026-02-16T09:10:17.3300693+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "bdb00476-4014-42a3-af58-4a25e9f6eea4",
"date_reported_by_company": "2026-02-16T09:10:17.3300693+00:00",
"id2": 36,
"company_id": "2721d6fc-fa1f-4439-8ecf-322acf1110be",
"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": "f72df008-06e1-4e8c-a940-e8c7f367f4b8",
"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-16T09:10:17.3300693+00:00"
},
"work_instruction_details_id": "24b15ca5-177a-4346-8701-4780849f53b8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "bde78b52-7e9e-4b53-8f98-262072c5e0a2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "556e7f43-b00f-47b9-a9dd-953c4bf3b42f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-16T09:10:17.3300693+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": "baaa9d73-2e2d-4b80-810f-2ed211e3d771",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-16T09:10:17.3300693+00:00"
}