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": "7dc6f9d1-f334-4289-9cf1-b3cf22ad4bf1",
"jobs_id": "c6f9fa2c-5a91-4b6d-ad6e-e590838eb92c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f7c51d63-d240-4e78-b414-d488ba1809c2",
"_parent_id": "9d04960c-9096-4699-8d7f-1852d332f79b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8b1094c7-d7b1-4090-a045-aca1741b0052",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6022d9dc-4dc3-4b79-a9c1-6ec1573c969e",
"_parent_id": "a374fb6c-5df4-4e62-8bd3-45fa73e973da",
"root_parent_id": "f93f8fb3-a1eb-41bd-8af3-e6e6ed567a96",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "72ea05ee-a63a-481b-908e-2c3b8d66451b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a0e9065a-90b2-4cbd-a557-bea13b4a1ad8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cc6aafd0-b4ab-4698-a01b-dccaa309629a",
"_parent_code": "sample string 6",
"sales_organization_id": "78bd3603-1c4d-4821-a453-a6a2d3b25ec4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f7458bc1-c574-4e9c-bfa7-97fc581ed6e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "06c976a1-43e7-46c9-b682-70c9e573cf07",
"db_currency_id": "f5dcacc7-c62f-43ae-b232-ae84a819b362",
"db_language_id": "61b0ee55-9705-4e92-99be-2f1dcdb3e797",
"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-09-01T17:57:46.6837504+00:00"
},
"modified_dateutc": "2026-09-01T17:57:46.6837504+00:00"
},
"equipment_model_id": "55a745a2-e39b-48f0-88aa-1e93b8439919",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3a44c14e-312d-4e30-8de6-70fa25ad2b0f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f85542d6-67ee-4742-b35a-94a4924c4cd0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "100957d0-0fa1-4a8a-a8fa-5633b241c8e2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ca38bae7-ba41-4aae-8c0c-371738ada62e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f7458bc1-c574-4e9c-bfa7-97fc581ed6e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "06c976a1-43e7-46c9-b682-70c9e573cf07",
"db_currency_id": "f5dcacc7-c62f-43ae-b232-ae84a819b362",
"db_language_id": "61b0ee55-9705-4e92-99be-2f1dcdb3e797",
"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-09-01T17:57:46.6837504+00:00"
},
"modified_dateutc": "2026-09-01T17:57:46.6837504+00:00"
},
"equipment_family_id": "6fe14866-8d07-403e-a758-de8ed736aeb3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a0e9065a-90b2-4cbd-a557-bea13b4a1ad8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cc6aafd0-b4ab-4698-a01b-dccaa309629a",
"_parent_code": "sample string 6",
"sales_organization_id": "78bd3603-1c4d-4821-a453-a6a2d3b25ec4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f7458bc1-c574-4e9c-bfa7-97fc581ed6e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "06c976a1-43e7-46c9-b682-70c9e573cf07",
"db_currency_id": "f5dcacc7-c62f-43ae-b232-ae84a819b362",
"db_language_id": "61b0ee55-9705-4e92-99be-2f1dcdb3e797",
"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-09-01T17:57:46.6837504+00:00"
},
"modified_dateutc": "2026-09-01T17:57:46.6837504+00:00"
},
"date_in_production_since": "2026-09-01T17:57:46.6837504+00:00",
"date_out_of_production_since": "2026-09-01T17:57:46.6837504+00:00",
"date_end_support": "2026-09-01T17:57:46.6837504+00:00",
"sales_organization_id": "8fa4355e-7667-46ee-a243-a6c380cd032a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f7458bc1-c574-4e9c-bfa7-97fc581ed6e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "06c976a1-43e7-46c9-b682-70c9e573cf07",
"db_currency_id": "f5dcacc7-c62f-43ae-b232-ae84a819b362",
"db_language_id": "61b0ee55-9705-4e92-99be-2f1dcdb3e797",
"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-09-01T17:57:46.6837504+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-09-01T17:57:46.6837504+00:00"
},
"project_status_id": "128d6799-cd79-4f7f-9043-0b9c9f520370",
"project_status_code": "sample string 10",
"project_status": {
"id": "5836eea7-7135-4b5d-bd6a-54fe85558603",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "50a8a27c-fe8e-4626-8cec-7857cca58318",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f7458bc1-c574-4e9c-bfa7-97fc581ed6e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "06c976a1-43e7-46c9-b682-70c9e573cf07",
"db_currency_id": "f5dcacc7-c62f-43ae-b232-ae84a819b362",
"db_language_id": "61b0ee55-9705-4e92-99be-2f1dcdb3e797",
"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-09-01T17:57:46.6837504+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-01T17:57:46.6837504+00:00"
},
"company_id": "16d26e2b-12ee-407e-9915-8b226144a20c",
"company_code": "sample string 12",
"db_address_id": "2391151c-a6a9-44c2-8483-b7b2bed2eb22",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6d69c81e-0d51-4b9c-a559-64e251bbb935",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "dc361589-1842-4afe-8f12-4791625a7fdd",
"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-09-01T17:57:46.6837504+00:00",
"date_create": "2026-09-01T17:57:46.6837504+00:00",
"date_update": "2026-09-01T17:57:46.6837504+00:00",
"updated_by_user_id": "dfd28097-8728-4ddb-ac88-ff79a4027a29",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-01T17:57:46.6837504+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-09-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-01T17:57:46.6837504+00:00",
"date_last_job": "2026-09-01T17:57:46.6837504+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-01T17:57:46.6837504+00:00",
"modified_dateutc": "2026-09-01T17:57:46.6837504+00:00",
"is_mobile_installation": true
},
"job_type_id": "499c2967-9deb-48cf-ad55-34c5740e9244",
"job_type_code": "sample string 7",
"job_type": {
"id": "0564f03d-2579-45e9-92e5-a5a202a38aee",
"name": "sample string 2",
"sales_organization_id": "5674faa5-c98a-415e-8c10-f6a61435d0d0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-01T17:57:46.6837504+00:00",
"code": "sample string 7"
},
"job_priority_id": "bd904758-56c4-4654-944d-3304eaaf9bf9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a7091bc4-e3d4-4bb1-9545-2f33e2c238a4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3d5646c5-f24d-4252-a855-03409cc2d839",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f7458bc1-c574-4e9c-bfa7-97fc581ed6e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "06c976a1-43e7-46c9-b682-70c9e573cf07",
"db_currency_id": "f5dcacc7-c62f-43ae-b232-ae84a819b362",
"db_language_id": "61b0ee55-9705-4e92-99be-2f1dcdb3e797",
"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-09-01T17:57:46.6837504+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-01T17:57:46.6837504+00:00"
},
"job_status_id": "365e4e21-6e6f-4c9c-a253-4366ace6864a",
"job_status_code": "sample string 11",
"db_address_id": "29af07a0-5c79-40d3-9ed7-d147fd18b0cb",
"contact_id": "e74f17a3-c944-4c0f-9e90-9f3ffd54b734",
"requested_by_company_id": "14521c00-d7e2-4b89-a1bf-c3bb4093b5f2",
"requested_by_contact_id": "d01d5e9e-efba-4ecc-ba76-0b0bf23daacc",
"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-09-01T17:57:46.6837504+00:00",
"due_date": "2026-09-01T17:57:46.6837504+00:00",
"date_create": "2026-09-01T17:57:46.6837504+00:00",
"date_update": "2026-09-01T17:57:46.6837504+00:00",
"date_closed": "2026-09-01T17:57:46.6837504+00:00",
"suggested_user_id": "5f1f4b25-a051-4f52-b5df-65b2fdfd2395",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b1d07a40-4696-4001-a337-b764fd99017e",
"db_language_id": "6fa1a840-7ca7-4ac1-b1d1-879ea0341ee5",
"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-09-01T17:57:46.6837504+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1048b4d0-edb0-4fd4-8d29-d115399727b7",
"sales_organization": {
"id": "f7458bc1-c574-4e9c-bfa7-97fc581ed6e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "06c976a1-43e7-46c9-b682-70c9e573cf07",
"db_currency_id": "f5dcacc7-c62f-43ae-b232-ae84a819b362",
"db_language_id": "61b0ee55-9705-4e92-99be-2f1dcdb3e797",
"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-09-01T17:57:46.6837504+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7d4ee9e1-f0ff-4d6e-9317-2702ff697a93",
"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": "845ffe3d-4dfb-4b0d-b03d-db0df849c5a0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-01T17:57:46.6837504+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b922da1c-4dc5-4702-a1e6-8623769feea7"
},
"suggested_date_start": "2026-09-01T17:57:46.6837504+00:00",
"skill_id": "76fc1977-1715-4f9d-831a-5603aea27bbf",
"skill_code": "sample string 32",
"skill": {
"id": "d35fd06a-8893-4ae1-88c8-ef1602f959dd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "68794317-f8cf-4fbd-a669-7f8862f157f7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f7458bc1-c574-4e9c-bfa7-97fc581ed6e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "06c976a1-43e7-46c9-b682-70c9e573cf07",
"db_currency_id": "f5dcacc7-c62f-43ae-b232-ae84a819b362",
"db_language_id": "61b0ee55-9705-4e92-99be-2f1dcdb3e797",
"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-09-01T17:57:46.6837504+00:00"
},
"modified_dateutc": "2026-09-01T17:57:46.6837504+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "daca0cb2-a17c-4473-9a5e-3183cc173196",
"date_reported_by_company": "2026-09-01T17:57:46.6837504+00:00",
"id2": 36,
"company_id": "eb3a275c-e6fc-465b-a928-49331a4406c1",
"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": "3d8661f6-bb74-4714-999d-2f709453ca80",
"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-09-01T17:57:46.6837504+00:00"
},
"work_instruction_details_id": "2d0fb67d-8d80-4c7a-9cb2-7866d5e2f8dc",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9dd8ecb7-899b-43ca-9d69-6229540356c9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "39e0a538-23f3-4f2f-bf4f-518d6c0d7473",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-01T17:57:46.6837504+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": "3e996b88-37c0-4d9b-a3e4-8edc097ea273",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-01T17:57:46.6837504+00:00"
}