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": "bb7fdcad-824a-40b5-852b-093a9f598115",
"jobs_id": "e7508f57-52bb-43d2-9235-28d7de09477a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6958c18c-423c-49e2-9ea8-8b90c8557b74",
"_parent_id": "fec32a39-41ea-485c-9da1-82707b168a54",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "cb9fabd5-beee-4bfe-9c78-5d3a6ea480eb",
"project_reference_back_office": "sample string 5",
"project": {
"id": "70c07d19-b344-49d8-ae50-8a974b19dcec",
"_parent_id": "b8a2962e-1173-4d57-83dc-aafa862ee384",
"root_parent_id": "cb1a37a0-63ff-476d-892e-f969a0989ebc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e6ff302d-4519-4a4b-8c41-0d1abd911a7c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4b46c076-ffd0-46b7-9bbd-f4a47595534a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "71630a83-3ded-44dd-85dc-bfa94e6331e7",
"_parent_code": "sample string 6",
"sales_organization_id": "903a7fb4-eeba-48e2-ac96-f314c9acc14d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c456761d-4dec-4707-b5da-2d6afbeab83b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8895ca11-df68-442d-90e9-81ddb18ac752",
"db_currency_id": "2a41ebab-64f4-4612-94db-6554bddb0954",
"db_language_id": "fa510e54-6861-4c3b-9ee4-0df5f851f842",
"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-03-12T23:27:35.6268434+00:00"
},
"modified_dateutc": "2026-03-12T23:27:35.6268434+00:00"
},
"equipment_model_id": "224e74b0-8fd5-4e64-b6a7-95a45da4446d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "509c2064-769d-4980-8f7a-b5b05324d779",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3b17a808-9a67-4ddf-81a2-32e4ec1373b2",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ba710735-ba4d-453b-ad87-9885ff8a803e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "492b611c-b1db-4ebd-9aaf-7f1bb05f0bc5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c456761d-4dec-4707-b5da-2d6afbeab83b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8895ca11-df68-442d-90e9-81ddb18ac752",
"db_currency_id": "2a41ebab-64f4-4612-94db-6554bddb0954",
"db_language_id": "fa510e54-6861-4c3b-9ee4-0df5f851f842",
"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-03-12T23:27:35.6268434+00:00"
},
"modified_dateutc": "2026-03-12T23:27:35.6268434+00:00"
},
"equipment_family_id": "d3038f6d-5a24-474c-908a-a64359641298",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4b46c076-ffd0-46b7-9bbd-f4a47595534a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "71630a83-3ded-44dd-85dc-bfa94e6331e7",
"_parent_code": "sample string 6",
"sales_organization_id": "903a7fb4-eeba-48e2-ac96-f314c9acc14d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c456761d-4dec-4707-b5da-2d6afbeab83b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8895ca11-df68-442d-90e9-81ddb18ac752",
"db_currency_id": "2a41ebab-64f4-4612-94db-6554bddb0954",
"db_language_id": "fa510e54-6861-4c3b-9ee4-0df5f851f842",
"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-03-12T23:27:35.6268434+00:00"
},
"modified_dateutc": "2026-03-12T23:27:35.6268434+00:00"
},
"date_in_production_since": "2026-03-12T23:27:35.6268434+00:00",
"date_out_of_production_since": "2026-03-12T23:27:35.6268434+00:00",
"date_end_support": "2026-03-12T23:27:35.6268434+00:00",
"sales_organization_id": "1f6ae348-fe2c-47bd-8410-21cafd5d6bb7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c456761d-4dec-4707-b5da-2d6afbeab83b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8895ca11-df68-442d-90e9-81ddb18ac752",
"db_currency_id": "2a41ebab-64f4-4612-94db-6554bddb0954",
"db_language_id": "fa510e54-6861-4c3b-9ee4-0df5f851f842",
"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-03-12T23:27:35.6268434+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-03-12T23:27:35.6268434+00:00"
},
"project_status_id": "dc7b639a-4dd5-46c2-8e6c-d4bb66adbe81",
"project_status_code": "sample string 10",
"project_status": {
"id": "305131df-12c2-4d9d-b68c-bf64586cac8b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "38c7ecdf-b38b-4edf-9b6b-ac06309aee27",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c456761d-4dec-4707-b5da-2d6afbeab83b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8895ca11-df68-442d-90e9-81ddb18ac752",
"db_currency_id": "2a41ebab-64f4-4612-94db-6554bddb0954",
"db_language_id": "fa510e54-6861-4c3b-9ee4-0df5f851f842",
"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-03-12T23:27:35.6268434+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-12T23:27:35.6268434+00:00"
},
"company_id": "16a31a66-1f09-4566-8cf7-1221aa26b092",
"company_code": "sample string 12",
"db_address_id": "39709a80-09f3-4e66-8e94-5945bd2bb740",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5e799d66-ce5c-406b-9c0e-53c4d1de094c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e03a4e1f-7506-4647-b3ba-90b4b8b74455",
"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-03-12T23:27:35.6268434+00:00",
"date_create": "2026-03-12T23:27:35.6268434+00:00",
"date_update": "2026-03-12T23:27:35.6268434+00:00",
"updated_by_user_id": "085e6212-0356-4487-a37c-0f71581beae0",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-12T23:27:35.6268434+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-03-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-12T23:27:35.6268434+00:00",
"date_last_job": "2026-03-12T23:27:35.6268434+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-12T23:27:35.6268434+00:00",
"modified_dateutc": "2026-03-12T23:27:35.6268434+00:00",
"is_mobile_installation": true
},
"job_type_id": "5ba0740d-c38f-479f-a8d9-152ee38c877a",
"job_type_code": "sample string 7",
"job_type": {
"id": "b33eef28-2e2f-4058-9fad-7aaef1b66357",
"name": "sample string 2",
"sales_organization_id": "6a555624-ddb7-46ed-b1c8-ea9b4a682ce7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-12T23:27:35.6268434+00:00",
"code": "sample string 7"
},
"job_priority_id": "6b808434-f90e-4081-b4fc-45d97728d89a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "88d307ae-8552-45d7-9958-76220509aedf",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "664f780d-1df6-42ff-afe1-8bdb6fae5355",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c456761d-4dec-4707-b5da-2d6afbeab83b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8895ca11-df68-442d-90e9-81ddb18ac752",
"db_currency_id": "2a41ebab-64f4-4612-94db-6554bddb0954",
"db_language_id": "fa510e54-6861-4c3b-9ee4-0df5f851f842",
"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-03-12T23:27:35.6268434+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-12T23:27:35.6268434+00:00"
},
"job_status_id": "8cdbaaa4-93fa-47fa-a589-0836b4347d81",
"job_status_code": "sample string 11",
"db_address_id": "3b2f03e3-b939-4729-9beb-522aa798c524",
"contact_id": "190404e6-e406-4fa8-a789-bdfd1ebaee9d",
"requested_by_company_id": "80dd0027-03d0-4466-abd0-3832afd1905d",
"requested_by_contact_id": "6260f625-8e83-4196-8e84-09023ba0f6df",
"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-03-12T23:27:35.6268434+00:00",
"due_date": "2026-03-12T23:27:35.6268434+00:00",
"date_create": "2026-03-12T23:27:35.6268434+00:00",
"date_update": "2026-03-12T23:27:35.6268434+00:00",
"date_closed": "2026-03-12T23:27:35.6268434+00:00",
"suggested_user_id": "48e9ae11-eddf-4504-b446-47febc8039b2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "dea515c3-0f4b-4961-8452-553cd7745305",
"db_language_id": "9a5421e8-2014-4bc8-8710-b7f260467a68",
"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-03-12T23:27:35.6268434+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "bb11cd49-a333-4a8d-84fb-381d27a5f5a0",
"sales_organization": {
"id": "c456761d-4dec-4707-b5da-2d6afbeab83b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8895ca11-df68-442d-90e9-81ddb18ac752",
"db_currency_id": "2a41ebab-64f4-4612-94db-6554bddb0954",
"db_language_id": "fa510e54-6861-4c3b-9ee4-0df5f851f842",
"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-03-12T23:27:35.6268434+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2f716e3f-5a31-4488-9a83-590b1a3589c8",
"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": "e25c406f-f83d-41f3-afa9-df9fc90b3f3d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-12T23:27:35.6268434+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d34ede86-f050-4b40-a8c9-1daa3b0511eb"
},
"suggested_date_start": "2026-03-12T23:27:35.6268434+00:00",
"skill_id": "c305ec34-f676-4ea9-bdd4-5213eaa40f00",
"skill_code": "sample string 32",
"skill": {
"id": "5ffec602-29e0-41a4-8090-9e894e236786",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3b53b879-7157-4b79-927d-02df4539dc15",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c456761d-4dec-4707-b5da-2d6afbeab83b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8895ca11-df68-442d-90e9-81ddb18ac752",
"db_currency_id": "2a41ebab-64f4-4612-94db-6554bddb0954",
"db_language_id": "fa510e54-6861-4c3b-9ee4-0df5f851f842",
"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-03-12T23:27:35.6268434+00:00"
},
"modified_dateutc": "2026-03-12T23:27:35.6268434+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d20c5000-28f1-4fb9-8775-586a9a0a55b2",
"date_reported_by_company": "2026-03-12T23:27:35.6268434+00:00",
"id2": 36,
"company_id": "94e12709-05af-4d4f-a826-f83b6ccd7615",
"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": "3d30836a-48cf-43a8-89fc-19460113cf01",
"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-03-12T23:27:35.6268434+00:00"
},
"work_instruction_details_id": "543b6d9a-adc6-422b-baad-e7dbe4978c72",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c8b0fb41-868e-443e-94a4-c6e92225ed4f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "271cd1a4-6e0b-4f66-9f55-e5dd670c7bca",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-12T23:27:35.6268434+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": "8c075290-9313-4712-bd78-383ec18b391f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-12T23:27:35.6268434+00:00"
}