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": "102c897c-b9f3-4a65-aa30-916d8088a0d1",
"jobs_id": "3069d706-0342-4ed2-8e45-eb0405d8d548",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f569b7d0-8082-4d3c-a3dd-bc1b54182a76",
"_parent_id": "cd4763da-955e-4154-9934-4cf6bb036ebc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c72ea2f8-33ad-49c4-a269-b794e0a3a052",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5946044b-2d65-42a4-946b-5b6888f9b650",
"_parent_id": "20971220-626c-4447-9298-16247084e8b7",
"root_parent_id": "1415db51-61c2-43f5-bf57-a3b5169571a1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4e03ddc4-a2b5-4f69-8cb3-70e21de1f1f7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "91847769-e57b-4f3a-86ab-477613a0eb01",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0be34815-f358-4c9e-ac3a-1c779b299ddb",
"_parent_code": "sample string 6",
"sales_organization_id": "c80d73e2-8aa2-4dfc-ab24-7842ec290c52",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "53217761-8f45-4b01-a581-c7926ef81bd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "573a6c68-b449-4e48-8233-735166f75683",
"db_currency_id": "ca5ec6db-7e49-4c8a-bed8-fe46c8b12ea7",
"db_language_id": "04fd3619-8278-430a-9ab4-0c709a925250",
"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-06-09T07:07:49.6533141+00:00"
},
"modified_dateutc": "2026-06-09T07:07:49.6533141+00:00"
},
"equipment_model_id": "feb99b65-3c60-42e1-ab71-719deeca12ef",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "05bec712-dc2c-41cf-a4cb-b5ac63148266",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d9e36469-13e7-4f98-a979-95cf9b94ba34",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "daac2b2c-a401-42e3-b10d-3f1cf23ccbc1",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f91dfff7-1697-4ef8-83cb-7247953c706f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "53217761-8f45-4b01-a581-c7926ef81bd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "573a6c68-b449-4e48-8233-735166f75683",
"db_currency_id": "ca5ec6db-7e49-4c8a-bed8-fe46c8b12ea7",
"db_language_id": "04fd3619-8278-430a-9ab4-0c709a925250",
"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-06-09T07:07:49.6533141+00:00"
},
"modified_dateutc": "2026-06-09T07:07:49.6533141+00:00"
},
"equipment_family_id": "9f0b146b-53d2-40c4-bd59-a7f85e5929a9",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "91847769-e57b-4f3a-86ab-477613a0eb01",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0be34815-f358-4c9e-ac3a-1c779b299ddb",
"_parent_code": "sample string 6",
"sales_organization_id": "c80d73e2-8aa2-4dfc-ab24-7842ec290c52",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "53217761-8f45-4b01-a581-c7926ef81bd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "573a6c68-b449-4e48-8233-735166f75683",
"db_currency_id": "ca5ec6db-7e49-4c8a-bed8-fe46c8b12ea7",
"db_language_id": "04fd3619-8278-430a-9ab4-0c709a925250",
"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-06-09T07:07:49.6533141+00:00"
},
"modified_dateutc": "2026-06-09T07:07:49.6533141+00:00"
},
"date_in_production_since": "2026-06-09T07:07:49.6533141+00:00",
"date_out_of_production_since": "2026-06-09T07:07:49.6533141+00:00",
"date_end_support": "2026-06-09T07:07:49.6533141+00:00",
"sales_organization_id": "5fc49319-13b2-44cf-8e89-47ed3e0a4966",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "53217761-8f45-4b01-a581-c7926ef81bd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "573a6c68-b449-4e48-8233-735166f75683",
"db_currency_id": "ca5ec6db-7e49-4c8a-bed8-fe46c8b12ea7",
"db_language_id": "04fd3619-8278-430a-9ab4-0c709a925250",
"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-06-09T07:07:49.6533141+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-06-09T07:07:49.6533141+00:00"
},
"project_status_id": "b2b29e26-b2c6-47a9-a177-397ee63a198f",
"project_status_code": "sample string 10",
"project_status": {
"id": "c00d5043-3ed9-4ecb-96ea-5a590da9d348",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4065bc9f-5ce2-431e-9c7d-2004592c3d08",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "53217761-8f45-4b01-a581-c7926ef81bd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "573a6c68-b449-4e48-8233-735166f75683",
"db_currency_id": "ca5ec6db-7e49-4c8a-bed8-fe46c8b12ea7",
"db_language_id": "04fd3619-8278-430a-9ab4-0c709a925250",
"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-06-09T07:07:49.6533141+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-09T07:07:49.6533141+00:00"
},
"company_id": "55692528-ad48-4120-9ca7-a3b7cb8a0135",
"company_code": "sample string 12",
"db_address_id": "184a707b-c083-439e-a39e-4b35a037dfdb",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0123de23-42dd-4b9c-84a2-62e0e4f43ddd",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f77e0b1c-6197-4eb6-9f8f-95bf6e9b4b84",
"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-06-09T07:07:49.6533141+00:00",
"date_create": "2026-06-09T07:07:49.6533141+00:00",
"date_update": "2026-06-09T07:07:49.6533141+00:00",
"updated_by_user_id": "9c49037c-f6ba-4e18-b817-dafab0cf8e6f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-09T07:07:49.6533141+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-06-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-09T07:07:49.6533141+00:00",
"date_last_job": "2026-06-09T07:07:49.6533141+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-09T07:07:49.6533141+00:00",
"modified_dateutc": "2026-06-09T07:07:49.6533141+00:00",
"is_mobile_installation": true
},
"job_type_id": "9ded68b9-693c-4ff2-bfe1-d96f0486ec38",
"job_type_code": "sample string 7",
"job_type": {
"id": "0184b497-a841-444d-a67f-f4b7fe8ad751",
"name": "sample string 2",
"sales_organization_id": "096a9395-8f34-45ac-9d84-0089514aac07",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-09T07:07:49.6533141+00:00",
"code": "sample string 7"
},
"job_priority_id": "485279e2-0f57-4c21-8b5f-a4a238cfaf0d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "84caa446-f224-4114-839f-eb2e3cb1c87b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6d366887-78d2-4669-8e1a-071ccb284c2e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "53217761-8f45-4b01-a581-c7926ef81bd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "573a6c68-b449-4e48-8233-735166f75683",
"db_currency_id": "ca5ec6db-7e49-4c8a-bed8-fe46c8b12ea7",
"db_language_id": "04fd3619-8278-430a-9ab4-0c709a925250",
"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-06-09T07:07:49.6533141+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-09T07:07:49.6533141+00:00"
},
"job_status_id": "caf30a97-8c7f-477c-a3d0-bc05b8d4abb9",
"job_status_code": "sample string 11",
"db_address_id": "f31e6930-a194-45f6-8cc0-a3f7fbc4d4dc",
"contact_id": "aeedae01-3c9e-488d-9837-fddbdee76ca1",
"requested_by_company_id": "53340383-dfe5-4fd1-8258-05fb1025801e",
"requested_by_contact_id": "78c924f9-551f-46a1-827d-972d67fc45e3",
"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-06-09T07:07:49.6533141+00:00",
"due_date": "2026-06-09T07:07:49.6533141+00:00",
"date_create": "2026-06-09T07:07:49.6533141+00:00",
"date_update": "2026-06-09T07:07:49.6533141+00:00",
"date_closed": "2026-06-09T07:07:49.6533141+00:00",
"suggested_user_id": "307c07a0-9b90-4030-84ef-9f023e03da06",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "64be60b0-a1d4-4df9-9403-9ecea24c76d6",
"db_language_id": "bc50882a-4221-4446-bf67-dc295a6501a7",
"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-06-09T07:07:49.6533141+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9cc4d831-3d43-4617-9cf7-4682a32e379e",
"sales_organization": {
"id": "53217761-8f45-4b01-a581-c7926ef81bd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "573a6c68-b449-4e48-8233-735166f75683",
"db_currency_id": "ca5ec6db-7e49-4c8a-bed8-fe46c8b12ea7",
"db_language_id": "04fd3619-8278-430a-9ab4-0c709a925250",
"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-06-09T07:07:49.6533141+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "89443727-a5d5-4c9a-afda-a44108ee6e1a",
"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": "30d1339b-81a8-404b-bf67-9215051ec01d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-09T07:07:49.6533141+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "523b30ae-1949-4386-99b6-6f59f5697064"
},
"suggested_date_start": "2026-06-09T07:07:49.6533141+00:00",
"skill_id": "e5a5c27b-8385-4374-aea0-61611552593b",
"skill_code": "sample string 32",
"skill": {
"id": "dbfdb66a-dc34-4370-941e-9600f5a02bc0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d69d4ec1-f4c9-4fba-8e24-01db07eabe51",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "53217761-8f45-4b01-a581-c7926ef81bd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "573a6c68-b449-4e48-8233-735166f75683",
"db_currency_id": "ca5ec6db-7e49-4c8a-bed8-fe46c8b12ea7",
"db_language_id": "04fd3619-8278-430a-9ab4-0c709a925250",
"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-06-09T07:07:49.6533141+00:00"
},
"modified_dateutc": "2026-06-09T07:07:49.6533141+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ed9d0126-5e62-439c-b477-d0fe3dbf472f",
"date_reported_by_company": "2026-06-09T07:07:49.6533141+00:00",
"id2": 36,
"company_id": "6a34c81a-2976-4454-bb89-9f068758a303",
"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": "46af2084-bd42-4ec5-8e8f-b944d0ef33d7",
"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-06-09T07:07:49.6533141+00:00"
},
"work_instruction_details_id": "f6a832d2-afbe-45b5-ac6c-3a47723d4c9c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "23cf49ef-3aa7-4e07-b3ee-b18ccf04539a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6c9c9edf-a89a-4c43-a91f-deea925fca58",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-09T07:07:49.6533141+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": "45594470-4310-497c-9b1b-f3416549d5b6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-09T07:07:49.6533141+00:00"
}