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": "88a48f2c-6804-464d-aee5-451338310fe3",
"jobs_id": "be7f19a5-a1b3-45e0-9642-d559972ff4e3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c8cb8dc9-7365-4828-90cc-792765652929",
"_parent_id": "fd479cf5-117c-4471-87df-0d05ee7fcd0e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b5143961-42c1-4826-9396-f552c85c06da",
"project_reference_back_office": "sample string 5",
"project": {
"id": "58e19ab6-f829-47e7-9bd8-a4662662c53a",
"_parent_id": "179a81ba-2875-4160-9301-d6b110cbf1b1",
"root_parent_id": "2c075e20-52dd-4e46-9f04-7c344114a074",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5c078582-4d30-42c8-89ee-6f430f6d4eee",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7f6524f6-303a-4b9b-90e0-06df16c29f60",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8b28b870-5438-49fd-89e6-d13e71448056",
"_parent_code": "sample string 6",
"sales_organization_id": "ee6a5b19-72ae-4cf4-bf6b-abcd0c4a10b1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9ea62f75-39c4-49b6-9ebc-5decbc6d86e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf959b3f-e073-4aa2-8a45-618d48546649",
"db_currency_id": "6156a255-46b5-4826-9e2c-330d0c0921b9",
"db_language_id": "396c0ad5-3d2f-4f8d-91a5-3195c6941215",
"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-10-05T10:59:06.3544981+00:00"
},
"modified_dateutc": "2026-10-05T10:59:06.3544981+00:00"
},
"equipment_model_id": "5f64e9c3-3e2a-4f92-be81-0b762e65897b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "57acf808-af51-41a7-81be-d495ab733da9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b6aa8f95-b937-4b81-9305-6a4882407df4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2814e40e-958b-4f8c-9877-f26059905e14",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "64b0ee5e-3403-44b5-961f-0123dbb048fa",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9ea62f75-39c4-49b6-9ebc-5decbc6d86e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf959b3f-e073-4aa2-8a45-618d48546649",
"db_currency_id": "6156a255-46b5-4826-9e2c-330d0c0921b9",
"db_language_id": "396c0ad5-3d2f-4f8d-91a5-3195c6941215",
"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-10-05T10:59:06.3544981+00:00"
},
"modified_dateutc": "2026-10-05T10:59:06.3544981+00:00"
},
"equipment_family_id": "ed827a9c-3a6b-4f8b-8b14-0684da7f5dc5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7f6524f6-303a-4b9b-90e0-06df16c29f60",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8b28b870-5438-49fd-89e6-d13e71448056",
"_parent_code": "sample string 6",
"sales_organization_id": "ee6a5b19-72ae-4cf4-bf6b-abcd0c4a10b1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9ea62f75-39c4-49b6-9ebc-5decbc6d86e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf959b3f-e073-4aa2-8a45-618d48546649",
"db_currency_id": "6156a255-46b5-4826-9e2c-330d0c0921b9",
"db_language_id": "396c0ad5-3d2f-4f8d-91a5-3195c6941215",
"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-10-05T10:59:06.3544981+00:00"
},
"modified_dateutc": "2026-10-05T10:59:06.3544981+00:00"
},
"date_in_production_since": "2026-10-05T10:59:06.3544981+00:00",
"date_out_of_production_since": "2026-10-05T10:59:06.3544981+00:00",
"date_end_support": "2026-10-05T10:59:06.3544981+00:00",
"sales_organization_id": "42f0a4d4-9d63-494b-a100-85a62f9e4230",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9ea62f75-39c4-49b6-9ebc-5decbc6d86e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf959b3f-e073-4aa2-8a45-618d48546649",
"db_currency_id": "6156a255-46b5-4826-9e2c-330d0c0921b9",
"db_language_id": "396c0ad5-3d2f-4f8d-91a5-3195c6941215",
"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-10-05T10:59:06.3544981+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-10-05T10:59:06.4043292+00:00"
},
"project_status_id": "7f695bdb-631c-4029-a131-b3f3cbe0109a",
"project_status_code": "sample string 10",
"project_status": {
"id": "38583e95-9352-495a-977e-95033bcc33ca",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4c5c452d-95c0-46cc-9801-c0dda99a31ec",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9ea62f75-39c4-49b6-9ebc-5decbc6d86e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf959b3f-e073-4aa2-8a45-618d48546649",
"db_currency_id": "6156a255-46b5-4826-9e2c-330d0c0921b9",
"db_language_id": "396c0ad5-3d2f-4f8d-91a5-3195c6941215",
"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-10-05T10:59:06.3544981+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-05T10:59:06.4043292+00:00"
},
"company_id": "0163c494-fa36-4fe8-a753-92945bf0f5fc",
"company_code": "sample string 12",
"db_address_id": "dd561ab6-dd55-473e-baff-b01c376d6c1e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "da4c7cb6-2411-4a43-83da-44fa2a91efa8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cc333cc9-61cc-4d82-936f-f24d15efc19a",
"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-10-05T10:59:06.4043292+00:00",
"date_create": "2026-10-05T10:59:06.4043292+00:00",
"date_update": "2026-10-05T10:59:06.4043292+00:00",
"updated_by_user_id": "68097199-b1b5-4f05-becc-b160ca81d9fb",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-05T10:59:06.4043292+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-10-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-05T10:59:06.4043292+00:00",
"date_last_job": "2026-10-05T10:59:06.4043292+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-05T10:59:06.4043292+00:00",
"modified_dateutc": "2026-10-05T10:59:06.4043292+00:00",
"is_mobile_installation": true
},
"job_type_id": "434ac9d4-7797-4907-9eb7-83e1f0bbc4fa",
"job_type_code": "sample string 7",
"job_type": {
"id": "fc047366-9640-4507-a78f-d7d7a61029e2",
"name": "sample string 2",
"sales_organization_id": "e8eb92a1-03ac-4b5e-a25e-944e3d0a1916",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-05T10:59:06.4043292+00:00",
"code": "sample string 7"
},
"job_priority_id": "980d4542-a96a-455b-a4d3-8419bf67962d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0e92377b-79fa-483b-ac7a-d20cf0511051",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "25b613a7-8c5e-4931-8595-651977b3dd54",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9ea62f75-39c4-49b6-9ebc-5decbc6d86e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf959b3f-e073-4aa2-8a45-618d48546649",
"db_currency_id": "6156a255-46b5-4826-9e2c-330d0c0921b9",
"db_language_id": "396c0ad5-3d2f-4f8d-91a5-3195c6941215",
"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-10-05T10:59:06.3544981+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-05T10:59:06.4043292+00:00"
},
"job_status_id": "6647f93e-8823-492c-a477-473128a68713",
"job_status_code": "sample string 11",
"db_address_id": "db3bd94e-622d-4d8d-8774-e7fd977d287b",
"contact_id": "d9a855b0-7c20-4955-9f7e-d1a7b05116ee",
"requested_by_company_id": "9e724382-933b-494d-a568-ed066a5378b2",
"requested_by_contact_id": "8d26a163-b4f4-419d-989c-80a62b86e516",
"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-10-05T10:59:06.4043292+00:00",
"due_date": "2026-10-05T10:59:06.4043292+00:00",
"date_create": "2026-10-05T10:59:06.4043292+00:00",
"date_update": "2026-10-05T10:59:06.4043292+00:00",
"date_closed": "2026-10-05T10:59:06.4043292+00:00",
"suggested_user_id": "e89b5593-c757-4d44-b344-5bc694d885a1",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "da182395-ad26-45c2-b6c6-723f6d6e303b",
"db_language_id": "b1ebd65e-fa8f-4a19-a4a0-e89c91987a73",
"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-10-05T10:59:06.4043292+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "28d5742e-6316-45fc-b81e-8184ca51ce13",
"sales_organization": {
"id": "9ea62f75-39c4-49b6-9ebc-5decbc6d86e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf959b3f-e073-4aa2-8a45-618d48546649",
"db_currency_id": "6156a255-46b5-4826-9e2c-330d0c0921b9",
"db_language_id": "396c0ad5-3d2f-4f8d-91a5-3195c6941215",
"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-10-05T10:59:06.3544981+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8e15f729-136a-4d1d-9d95-ce2d29ab13e1",
"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": "f80d5568-cf9a-494b-8fed-de0da58d78a3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-05T10:59:06.4214239+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7febe95a-361c-4265-a6d5-c0d7b59038f1"
},
"suggested_date_start": "2026-10-05T10:59:06.4214239+00:00",
"skill_id": "b6c9bc22-a477-4ce7-bb60-75b44e682c60",
"skill_code": "sample string 32",
"skill": {
"id": "4798c661-09a4-4e60-94a8-0da999b05a7f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2d93ce27-e74f-456e-82f4-dcb5650acbaa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9ea62f75-39c4-49b6-9ebc-5decbc6d86e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf959b3f-e073-4aa2-8a45-618d48546649",
"db_currency_id": "6156a255-46b5-4826-9e2c-330d0c0921b9",
"db_language_id": "396c0ad5-3d2f-4f8d-91a5-3195c6941215",
"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-10-05T10:59:06.3544981+00:00"
},
"modified_dateutc": "2026-10-05T10:59:06.4214239+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2bfa2854-5dfc-4edd-973b-a27683d5d734",
"date_reported_by_company": "2026-10-05T10:59:06.4214239+00:00",
"id2": 36,
"company_id": "65e8bf79-1171-4070-80f0-0592eb7e3dd0",
"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": "581def68-78d8-4d1b-80d0-4e048ebc2ffb",
"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-10-05T10:59:06.4214239+00:00"
},
"work_instruction_details_id": "55aa9859-a0cd-4d44-9f5b-4eda12250f3a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "bd51c9af-0b1e-4f87-9cdc-742b68d535b8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1d7cc057-ce16-4369-a3b4-19a5df0963e6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-05T10:59:06.4214239+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": "4e73c5d9-30f4-4fbe-aaab-c914b92b51d8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-05T10:59:06.4214239+00:00"
}