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": "b81b723e-9ae8-41b2-b099-9cbbfde52039",
"jobs_id": "4b696b08-d086-461d-b3ad-d8cd3409f978",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "70de3861-d923-4e7b-b818-b8c428d057e7",
"_parent_id": "280f5528-7cae-464d-8786-044d9909b5a7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "515d890b-61a7-48e0-bc47-f02db300fba8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "95ccdb1a-c6c3-4155-8f9a-1ced96e15728",
"_parent_id": "14de6e88-9eb6-4c81-9764-6dc240857278",
"root_parent_id": "ab84649c-06fc-4388-8abe-fbc77ee5c411",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "adf5f4b4-593f-4fdf-b5a8-01a2aa7c0453",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a432aac3-320c-45b9-b05d-599e1fb21b5c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e44e0dfb-32e1-42f0-962d-abd6b0f82f80",
"_parent_code": "sample string 6",
"sales_organization_id": "ad68d53d-4358-4c5b-a8ee-071cfa718d4d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "28a3a6a2-6880-4210-a6fd-fbbafb45d837",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4eb1f59f-b0c6-47fa-b7d2-b2ccb064be3c",
"db_currency_id": "c8c4df09-2fff-42be-a0f3-76ae07b6f180",
"db_language_id": "dec40c80-44a1-4e76-b0e1-761333e993e7",
"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-23T07:10:28.7675931+00:00"
},
"modified_dateutc": "2026-09-23T07:10:28.7675931+00:00"
},
"equipment_model_id": "92bbc63c-e5ff-4823-b52b-5db3b543f9fa",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "81e278fc-38bf-4018-a234-be2a1b5ed7e7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e2b99292-107f-4a4c-812e-08aa55502483",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f44e336f-58b4-4f5e-b2a0-a0850f130dbd",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6e62598c-42fd-4459-bff4-c35714ba4ed3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "28a3a6a2-6880-4210-a6fd-fbbafb45d837",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4eb1f59f-b0c6-47fa-b7d2-b2ccb064be3c",
"db_currency_id": "c8c4df09-2fff-42be-a0f3-76ae07b6f180",
"db_language_id": "dec40c80-44a1-4e76-b0e1-761333e993e7",
"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-23T07:10:28.7675931+00:00"
},
"modified_dateutc": "2026-09-23T07:10:28.7675931+00:00"
},
"equipment_family_id": "6b805d33-6db0-49d5-8646-7669be6b80b8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a432aac3-320c-45b9-b05d-599e1fb21b5c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e44e0dfb-32e1-42f0-962d-abd6b0f82f80",
"_parent_code": "sample string 6",
"sales_organization_id": "ad68d53d-4358-4c5b-a8ee-071cfa718d4d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "28a3a6a2-6880-4210-a6fd-fbbafb45d837",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4eb1f59f-b0c6-47fa-b7d2-b2ccb064be3c",
"db_currency_id": "c8c4df09-2fff-42be-a0f3-76ae07b6f180",
"db_language_id": "dec40c80-44a1-4e76-b0e1-761333e993e7",
"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-23T07:10:28.7675931+00:00"
},
"modified_dateutc": "2026-09-23T07:10:28.7675931+00:00"
},
"date_in_production_since": "2026-09-23T07:10:28.7675931+00:00",
"date_out_of_production_since": "2026-09-23T07:10:28.7675931+00:00",
"date_end_support": "2026-09-23T07:10:28.7675931+00:00",
"sales_organization_id": "b62763d0-a5f6-4011-bf72-8c3e869da220",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "28a3a6a2-6880-4210-a6fd-fbbafb45d837",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4eb1f59f-b0c6-47fa-b7d2-b2ccb064be3c",
"db_currency_id": "c8c4df09-2fff-42be-a0f3-76ae07b6f180",
"db_language_id": "dec40c80-44a1-4e76-b0e1-761333e993e7",
"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-23T07:10:28.7675931+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-23T07:10:28.7675931+00:00"
},
"project_status_id": "1b3c06bd-6cdc-4979-8de7-601552130440",
"project_status_code": "sample string 10",
"project_status": {
"id": "2d0dfaa7-5a82-45d0-a451-659b767012e1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4a05a4ac-1a41-4987-8b59-fa4c14e8d2ec",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "28a3a6a2-6880-4210-a6fd-fbbafb45d837",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4eb1f59f-b0c6-47fa-b7d2-b2ccb064be3c",
"db_currency_id": "c8c4df09-2fff-42be-a0f3-76ae07b6f180",
"db_language_id": "dec40c80-44a1-4e76-b0e1-761333e993e7",
"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-23T07:10:28.7675931+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-23T07:10:28.7675931+00:00"
},
"company_id": "606eb357-6ea9-4b9b-884c-a9c14bd37f83",
"company_code": "sample string 12",
"db_address_id": "fcac0c61-e325-4fbe-a64a-d14d7c3b0a76",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "97283306-4d6f-4075-9c92-021fbc3860e5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "64f15c22-4f37-40a4-9889-8f7cbb7decc8",
"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-23T07:10:28.7675931+00:00",
"date_create": "2026-09-23T07:10:28.7675931+00:00",
"date_update": "2026-09-23T07:10:28.7675931+00:00",
"updated_by_user_id": "24b35f5d-aca0-494f-8dff-739c29b83386",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-23T07:10:28.7675931+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-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-23T07:10:28.7675931+00:00",
"date_last_job": "2026-09-23T07:10:28.7675931+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-23T07:10:28.7675931+00:00",
"modified_dateutc": "2026-09-23T07:10:28.7675931+00:00",
"is_mobile_installation": true
},
"job_type_id": "7a60ea22-9296-4a6b-b21f-bab79ee8f388",
"job_type_code": "sample string 7",
"job_type": {
"id": "afd9c6ee-859d-46bb-b0af-b6b4a100c0f4",
"name": "sample string 2",
"sales_organization_id": "31022df5-3a32-4671-9120-139ad136e18b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-23T07:10:28.7675931+00:00",
"code": "sample string 7"
},
"job_priority_id": "e2edda58-c142-4749-8203-787ad168484b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7c25c14d-d1d4-46d4-8f87-60023e2fd067",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "fa7d3c25-e5bc-43b0-9292-27b9a2a1516f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "28a3a6a2-6880-4210-a6fd-fbbafb45d837",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4eb1f59f-b0c6-47fa-b7d2-b2ccb064be3c",
"db_currency_id": "c8c4df09-2fff-42be-a0f3-76ae07b6f180",
"db_language_id": "dec40c80-44a1-4e76-b0e1-761333e993e7",
"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-23T07:10:28.7675931+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-23T07:10:28.7675931+00:00"
},
"job_status_id": "9338639a-924f-481a-bc81-e24d7095c873",
"job_status_code": "sample string 11",
"db_address_id": "72849ed0-ed1e-47bd-92dd-27d712adad97",
"contact_id": "cb056a16-9f62-4bf8-b368-1d7ceed40f3e",
"requested_by_company_id": "406216bf-0416-4e62-b23c-294002bc396f",
"requested_by_contact_id": "c1fce33b-eb7e-4d81-85d2-9eb8ec9277cc",
"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-23T07:10:28.7675931+00:00",
"due_date": "2026-09-23T07:10:28.7675931+00:00",
"date_create": "2026-09-23T07:10:28.7675931+00:00",
"date_update": "2026-09-23T07:10:28.7675931+00:00",
"date_closed": "2026-09-23T07:10:28.7675931+00:00",
"suggested_user_id": "4da500b5-e9d3-4f20-b1d7-3381030fea5c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2bca47a6-f286-4422-b744-e9042325d9dc",
"db_language_id": "94fb7cb2-1d20-4eff-87c0-3d1fdee8b32c",
"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-23T07:10:28.7675931+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9762a084-7f3d-4e4c-965f-98ca80bd8c38",
"sales_organization": {
"id": "28a3a6a2-6880-4210-a6fd-fbbafb45d837",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4eb1f59f-b0c6-47fa-b7d2-b2ccb064be3c",
"db_currency_id": "c8c4df09-2fff-42be-a0f3-76ae07b6f180",
"db_language_id": "dec40c80-44a1-4e76-b0e1-761333e993e7",
"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-23T07:10:28.7675931+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5d0ba0ef-93c6-46bd-a279-d8b785ec7d59",
"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": "18c3a1a6-9304-4681-acbb-b7e8ca41b1f5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-23T07:10:28.7675931+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "db70436b-ee75-408e-a008-7691f566d448"
},
"suggested_date_start": "2026-09-23T07:10:28.7675931+00:00",
"skill_id": "fff0ce2e-4970-4fea-8f24-6a9ab987a4d2",
"skill_code": "sample string 32",
"skill": {
"id": "955d2cdf-fe5e-4658-97b1-685db1ec27c4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d72ce20f-993b-4877-9283-cccf7a629493",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "28a3a6a2-6880-4210-a6fd-fbbafb45d837",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4eb1f59f-b0c6-47fa-b7d2-b2ccb064be3c",
"db_currency_id": "c8c4df09-2fff-42be-a0f3-76ae07b6f180",
"db_language_id": "dec40c80-44a1-4e76-b0e1-761333e993e7",
"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-23T07:10:28.7675931+00:00"
},
"modified_dateutc": "2026-09-23T07:10:28.7675931+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fc0feaae-a7ec-41c7-8b1c-52baae538771",
"date_reported_by_company": "2026-09-23T07:10:28.7675931+00:00",
"id2": 36,
"company_id": "db505ac2-b71e-4146-91b1-7803d11c54af",
"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": "16706a62-b89e-4c92-a59e-6f6cca19f785",
"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-23T07:10:28.7675931+00:00"
},
"work_instruction_details_id": "a66cb327-57bc-4be8-a8b1-f4d08081faac",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f8d8437c-46b3-4146-b408-2b012e7e5ea9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2da167e7-6b4c-4003-8d5f-4ac2e03be7ac",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-23T07:10:28.7675931+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": "590f991a-ec27-4748-939c-789fd6ac2fb9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-23T07:10:28.7675931+00:00"
}