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": "54e2a3c1-74dc-4cf2-8421-19d582b1bc47",
"jobs_id": "d88b3dd7-bba7-4229-830d-09f667f15ecb",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c1ce2406-dfc6-4e18-9183-9d099db931b5",
"_parent_id": "39421fc9-91f8-4593-a10e-85f82371d476",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8aef26d3-0ba4-46d2-8667-80a2f2310cbd",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2d524a07-c214-4eb2-9837-5af9949c8b65",
"_parent_id": "d933f8ab-f0fa-4cab-b591-b2434aed27d2",
"root_parent_id": "822a0227-aa9d-46db-bc1f-69ea477f5224",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8aaab07f-a21f-4f61-b24a-975db1a4c861",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "db9b4aed-e84c-42c6-ab2b-a04bb90ed586",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ad78a5ca-43be-453c-bf44-37f385406bb8",
"_parent_code": "sample string 6",
"sales_organization_id": "6510752a-42f7-45d8-9a75-dbaac8301a04",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d088ae5b-e720-4d2f-9883-1012307c62d2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d49f08a-36c6-479d-b0b9-8853a821368d",
"db_currency_id": "9029192d-1271-4595-b01f-fe38780d97f2",
"db_language_id": "57bd9084-bac0-4d68-b456-7499d8178bc4",
"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-25T14:53:25.4653974+00:00"
},
"modified_dateutc": "2026-02-25T14:53:25.4653974+00:00"
},
"equipment_model_id": "00bda4e5-ebde-4747-84d3-7c50344a588c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "63cafbcb-39b5-404d-b7c4-197acb6933dd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "20ebd3c0-d1b0-4440-80d9-a4b744b7a383",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "78956d12-ab7e-4687-8de8-3e194237aac4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3695df3d-d7aa-40eb-b5b1-eebee58e5750",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d088ae5b-e720-4d2f-9883-1012307c62d2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d49f08a-36c6-479d-b0b9-8853a821368d",
"db_currency_id": "9029192d-1271-4595-b01f-fe38780d97f2",
"db_language_id": "57bd9084-bac0-4d68-b456-7499d8178bc4",
"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-25T14:53:25.4653974+00:00"
},
"modified_dateutc": "2026-02-25T14:53:25.4653974+00:00"
},
"equipment_family_id": "4c917b3a-2d20-4c06-9a3e-99bae61c8b54",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "db9b4aed-e84c-42c6-ab2b-a04bb90ed586",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ad78a5ca-43be-453c-bf44-37f385406bb8",
"_parent_code": "sample string 6",
"sales_organization_id": "6510752a-42f7-45d8-9a75-dbaac8301a04",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d088ae5b-e720-4d2f-9883-1012307c62d2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d49f08a-36c6-479d-b0b9-8853a821368d",
"db_currency_id": "9029192d-1271-4595-b01f-fe38780d97f2",
"db_language_id": "57bd9084-bac0-4d68-b456-7499d8178bc4",
"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-25T14:53:25.4653974+00:00"
},
"modified_dateutc": "2026-02-25T14:53:25.4653974+00:00"
},
"date_in_production_since": "2026-02-25T14:53:25.4653974+00:00",
"date_out_of_production_since": "2026-02-25T14:53:25.4653974+00:00",
"date_end_support": "2026-02-25T14:53:25.4653974+00:00",
"sales_organization_id": "d30176aa-87e3-4659-a3d3-45752bbf82e9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d088ae5b-e720-4d2f-9883-1012307c62d2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d49f08a-36c6-479d-b0b9-8853a821368d",
"db_currency_id": "9029192d-1271-4595-b01f-fe38780d97f2",
"db_language_id": "57bd9084-bac0-4d68-b456-7499d8178bc4",
"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-25T14:53:25.4653974+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-25T14:53:25.4653974+00:00"
},
"project_status_id": "b75220b9-3972-4935-b4ee-2a0cb2febe7a",
"project_status_code": "sample string 10",
"project_status": {
"id": "72949edf-982e-4f56-840e-e4353e3af263",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "25bd8c37-05cd-4fd1-b6f5-459e8e963c80",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d088ae5b-e720-4d2f-9883-1012307c62d2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d49f08a-36c6-479d-b0b9-8853a821368d",
"db_currency_id": "9029192d-1271-4595-b01f-fe38780d97f2",
"db_language_id": "57bd9084-bac0-4d68-b456-7499d8178bc4",
"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-25T14:53:25.4653974+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-25T14:53:25.4810206+00:00"
},
"company_id": "737d47f2-9ae6-4126-8c26-2b5a9f6509f5",
"company_code": "sample string 12",
"db_address_id": "c7581aec-56a6-457b-863a-4a70b62c3f40",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b7e40b3d-2fc6-415d-b5cb-aa1ba8f7eb29",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cdae2cea-7b30-4790-8ce4-57bc698b9c75",
"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-25T14:53:25.4810206+00:00",
"date_create": "2026-02-25T14:53:25.4810206+00:00",
"date_update": "2026-02-25T14:53:25.4810206+00:00",
"updated_by_user_id": "942de733-a5a0-404d-938f-92bca9c7f205",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-25T14:53:25.4810206+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-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-25T14:53:25.4810206+00:00",
"date_last_job": "2026-02-25T14:53:25.4810206+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-25T14:53:25.4810206+00:00",
"modified_dateutc": "2026-02-25T14:53:25.4810206+00:00",
"is_mobile_installation": true
},
"job_type_id": "0eaef8b4-5bb6-4949-8719-940368bc36fc",
"job_type_code": "sample string 7",
"job_type": {
"id": "03215e69-fb2d-42ed-9a9a-891c57a4ee22",
"name": "sample string 2",
"sales_organization_id": "469c93c9-c2f3-498e-9654-446381b1a441",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-25T14:53:25.4810206+00:00",
"code": "sample string 7"
},
"job_priority_id": "80d7c7be-c027-458f-93fb-504343be01f8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "690f243c-2b94-4df7-a5f1-8dfcfb882393",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c9c2b344-3ffa-4074-92f1-8998b6ae678e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d088ae5b-e720-4d2f-9883-1012307c62d2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d49f08a-36c6-479d-b0b9-8853a821368d",
"db_currency_id": "9029192d-1271-4595-b01f-fe38780d97f2",
"db_language_id": "57bd9084-bac0-4d68-b456-7499d8178bc4",
"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-25T14:53:25.4653974+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-25T14:53:25.4810206+00:00"
},
"job_status_id": "bcc323df-0880-47fe-9756-06048d49cb95",
"job_status_code": "sample string 11",
"db_address_id": "8f4b542b-3907-41bc-b917-dd4952aced24",
"contact_id": "25423501-c422-47ff-839d-4be35a5e01c6",
"requested_by_company_id": "a9c2b77f-0224-4580-bf35-20b1aa2d0c36",
"requested_by_contact_id": "ed124d61-6f0a-4bb1-bd7a-b7d3515c9f75",
"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-25T14:53:25.4810206+00:00",
"due_date": "2026-02-25T14:53:25.4810206+00:00",
"date_create": "2026-02-25T14:53:25.4810206+00:00",
"date_update": "2026-02-25T14:53:25.4810206+00:00",
"date_closed": "2026-02-25T14:53:25.4810206+00:00",
"suggested_user_id": "5c53d140-0cd4-48a9-831f-1053f7d402da",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "bd5f213b-259c-40ff-af85-58bddf4d2174",
"db_language_id": "7473e911-e05c-4d59-b884-fb6b5d5a1f7d",
"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-25T14:53:25.4810206+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9eb20698-6e20-459d-b944-d5a008325473",
"sales_organization": {
"id": "d088ae5b-e720-4d2f-9883-1012307c62d2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d49f08a-36c6-479d-b0b9-8853a821368d",
"db_currency_id": "9029192d-1271-4595-b01f-fe38780d97f2",
"db_language_id": "57bd9084-bac0-4d68-b456-7499d8178bc4",
"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-25T14:53:25.4653974+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7db700a4-ab02-41b5-b166-866292b56a97",
"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": "e3dd2b41-16c2-402a-a018-4316096780ef",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-25T14:53:25.4810206+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e26c73cb-79c6-4668-b930-0147c554a760"
},
"suggested_date_start": "2026-02-25T14:53:25.4810206+00:00",
"skill_id": "b9c92509-53c9-4c37-bb01-4e2cf48b7ef9",
"skill_code": "sample string 32",
"skill": {
"id": "1a921240-1948-42b5-ae96-79329460f5f9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7a049c31-cfc4-4375-b14c-9f607ebfc268",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d088ae5b-e720-4d2f-9883-1012307c62d2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d49f08a-36c6-479d-b0b9-8853a821368d",
"db_currency_id": "9029192d-1271-4595-b01f-fe38780d97f2",
"db_language_id": "57bd9084-bac0-4d68-b456-7499d8178bc4",
"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-25T14:53:25.4653974+00:00"
},
"modified_dateutc": "2026-02-25T14:53:25.4810206+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0f492f9f-f15c-469c-a552-2896d6e9a219",
"date_reported_by_company": "2026-02-25T14:53:25.4810206+00:00",
"id2": 36,
"company_id": "6404fec5-275f-460c-a054-3c802c7a2f16",
"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": "60840509-9587-4bb0-9fe4-8374898948d9",
"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-25T14:53:25.4810206+00:00"
},
"work_instruction_details_id": "fdd3625f-a513-4a92-b9e7-866e90844b97",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "624ccbde-713e-485b-8248-2c4092b594b5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f9f013b9-ad68-4955-8c0c-ddf052e1d830",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-25T14:53:25.4810206+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": "31a0daba-3f68-480e-9273-ff981018c0d2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-25T14:53:25.4810206+00:00"
}