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": "744a6d8a-7e5f-4b29-88db-fc2477081ea3",
"jobs_id": "c15824a1-1e9c-4448-bcf9-5014559193af",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "16c0018c-0a92-4ce5-a4de-7d7a47e919c3",
"_parent_id": "e67547a3-996d-44e0-90c0-78062c7a2a0e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0e88007c-884d-47b8-bd3c-1e8f5a75634c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e03948b5-044d-4581-8279-0e1333c56c7a",
"_parent_id": "42aade4a-0ffa-4157-939c-546a556c3e90",
"root_parent_id": "d43fd4d6-a87c-4341-81a9-4f901a375d77",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6daea409-338d-429f-b659-7abf042294aa",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f3c993bb-6e43-402b-acea-3a4e971598c5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a29b3a10-8292-41e8-a89d-c15bc8103231",
"_parent_code": "sample string 6",
"sales_organization_id": "4db6495b-fad1-434d-bdfd-ff0a1c2b6586",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c35b7e68-8d8c-484c-a2e1-14f74fba43e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fa8c0e5-69a5-4349-8044-0deed5cc7c12",
"db_currency_id": "aea22d59-f647-4be4-a9d4-c28deb357b05",
"db_language_id": "13ceeb6f-5a71-4714-8e31-8bc831df7776",
"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": "2025-10-09T20:13:03.211273+00:00"
},
"modified_dateutc": "2025-10-09T20:13:03.211273+00:00"
},
"equipment_model_id": "ab9d4aef-74ff-4ee6-beeb-ed07e48eb439",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3f7987d7-0b22-4ba4-b872-513a16fe9a94",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6da0257b-03e1-41c4-8aac-a37f4309adc7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f0547d40-c2fb-4456-b696-0f46177a4394",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5955cbbe-c7ba-422c-8461-c72aa586b05e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c35b7e68-8d8c-484c-a2e1-14f74fba43e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fa8c0e5-69a5-4349-8044-0deed5cc7c12",
"db_currency_id": "aea22d59-f647-4be4-a9d4-c28deb357b05",
"db_language_id": "13ceeb6f-5a71-4714-8e31-8bc831df7776",
"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": "2025-10-09T20:13:03.211273+00:00"
},
"modified_dateutc": "2025-10-09T20:13:03.2425339+00:00"
},
"equipment_family_id": "6e0a59a6-c750-46b7-9d1e-199cb629fb88",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f3c993bb-6e43-402b-acea-3a4e971598c5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a29b3a10-8292-41e8-a89d-c15bc8103231",
"_parent_code": "sample string 6",
"sales_organization_id": "4db6495b-fad1-434d-bdfd-ff0a1c2b6586",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c35b7e68-8d8c-484c-a2e1-14f74fba43e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fa8c0e5-69a5-4349-8044-0deed5cc7c12",
"db_currency_id": "aea22d59-f647-4be4-a9d4-c28deb357b05",
"db_language_id": "13ceeb6f-5a71-4714-8e31-8bc831df7776",
"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": "2025-10-09T20:13:03.211273+00:00"
},
"modified_dateutc": "2025-10-09T20:13:03.211273+00:00"
},
"date_in_production_since": "2025-10-09T20:13:03.2425339+00:00",
"date_out_of_production_since": "2025-10-09T20:13:03.2425339+00:00",
"date_end_support": "2025-10-09T20:13:03.2425339+00:00",
"sales_organization_id": "7c050002-af3c-4b08-85c4-c7573dd27733",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c35b7e68-8d8c-484c-a2e1-14f74fba43e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fa8c0e5-69a5-4349-8044-0deed5cc7c12",
"db_currency_id": "aea22d59-f647-4be4-a9d4-c28deb357b05",
"db_language_id": "13ceeb6f-5a71-4714-8e31-8bc831df7776",
"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": "2025-10-09T20:13:03.211273+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": "2025-10-09T20:13:03.2425339+00:00"
},
"project_status_id": "3a30e925-d0bd-4c8b-bba3-2ac6fcb3603d",
"project_status_code": "sample string 10",
"project_status": {
"id": "7cbe20ea-8956-4e0b-84b2-9d96b3f75077",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "51b3aaae-a822-45e8-8e60-522dcdcd4a53",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c35b7e68-8d8c-484c-a2e1-14f74fba43e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fa8c0e5-69a5-4349-8044-0deed5cc7c12",
"db_currency_id": "aea22d59-f647-4be4-a9d4-c28deb357b05",
"db_language_id": "13ceeb6f-5a71-4714-8e31-8bc831df7776",
"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": "2025-10-09T20:13:03.211273+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-09T20:13:03.2425339+00:00"
},
"company_id": "3e63f76f-23a8-4e80-bc5c-43966182633b",
"company_code": "sample string 12",
"db_address_id": "1ed82934-44ea-44f1-94b6-4a96087b046c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a3262948-711d-484e-b3aa-dcf9cf3110e9",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0af9865e-1b4c-4e22-9d15-9f6c8d0ed13e",
"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": "2025-10-09T20:13:03.2425339+00:00",
"date_create": "2025-10-09T20:13:03.2425339+00:00",
"date_update": "2025-10-09T20:13:03.2425339+00:00",
"updated_by_user_id": "8d884624-65b3-44f0-8be2-1306f1edb9e1",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-10-09T20:13:03.2425339+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": "2025-10-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-10-09T20:13:03.2425339+00:00",
"date_last_job": "2025-10-09T20:13:03.2425339+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-10-09T20:13:03.2425339+00:00",
"modified_dateutc": "2025-10-09T20:13:03.2425339+00:00",
"is_mobile_installation": true
},
"job_type_id": "6700008d-fad0-43e2-a480-b8366d019d0d",
"job_type_code": "sample string 7",
"job_type": {
"id": "8e7e41fe-ba07-4865-9af6-16c82367a9c9",
"name": "sample string 2",
"sales_organization_id": "60b9efb0-a89d-464d-a77e-a8ea9dbd5a4f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-10-09T20:13:03.2425339+00:00",
"code": "sample string 7"
},
"job_priority_id": "6680ab85-68db-4381-b11a-3ce9e405c5b8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "810d2e48-58a6-4117-92ba-41472fc2fe05",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "49c264c1-a837-47e6-9cd7-29257e67597b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c35b7e68-8d8c-484c-a2e1-14f74fba43e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fa8c0e5-69a5-4349-8044-0deed5cc7c12",
"db_currency_id": "aea22d59-f647-4be4-a9d4-c28deb357b05",
"db_language_id": "13ceeb6f-5a71-4714-8e31-8bc831df7776",
"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": "2025-10-09T20:13:03.211273+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-09T20:13:03.2425339+00:00"
},
"job_status_id": "3f699c56-bd62-438c-b0af-e3962e907f09",
"job_status_code": "sample string 11",
"db_address_id": "ad868305-e949-4f4b-907a-7e4583033dfd",
"contact_id": "ce41d401-8a92-45b3-8178-1bdba1cf5727",
"requested_by_company_id": "9c6aadd8-909d-4aff-9f28-2a30fffead1a",
"requested_by_contact_id": "da2ac6c6-ce19-43a1-8196-6b9eb8160480",
"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": "2025-10-09T20:13:03.2425339+00:00",
"due_date": "2025-10-09T20:13:03.2425339+00:00",
"date_create": "2025-10-09T20:13:03.2425339+00:00",
"date_update": "2025-10-09T20:13:03.2425339+00:00",
"date_closed": "2025-10-09T20:13:03.2425339+00:00",
"suggested_user_id": "06808928-a84a-4afb-bae5-52e245a1a5d5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f806e458-b1ed-4d69-8840-fb768c358631",
"db_language_id": "6a1b2474-bfa8-47e4-85d7-9328bffc6060",
"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": "2025-10-09T20:13:03.2425339+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4bd4722b-c6d2-4100-b1ed-54612074c029",
"sales_organization": {
"id": "c35b7e68-8d8c-484c-a2e1-14f74fba43e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fa8c0e5-69a5-4349-8044-0deed5cc7c12",
"db_currency_id": "aea22d59-f647-4be4-a9d4-c28deb357b05",
"db_language_id": "13ceeb6f-5a71-4714-8e31-8bc831df7776",
"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": "2025-10-09T20:13:03.211273+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "68aad541-7fe6-4834-ae4e-ea6dca6c823e",
"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": "8b8a6224-3511-40f2-a70b-3e1ea4bfacfb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-09T20:13:03.2425339+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f9235833-9537-49e4-adfa-d8f7672aec2a"
},
"suggested_date_start": "2025-10-09T20:13:03.2425339+00:00",
"skill_id": "c471262a-2439-4122-8f74-8c89b3ef421a",
"skill_code": "sample string 32",
"skill": {
"id": "2ce96599-fefd-4cc8-8232-9402e12ea3fc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0dbcd3a2-b659-485f-a7b8-34d57ec0717a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c35b7e68-8d8c-484c-a2e1-14f74fba43e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fa8c0e5-69a5-4349-8044-0deed5cc7c12",
"db_currency_id": "aea22d59-f647-4be4-a9d4-c28deb357b05",
"db_language_id": "13ceeb6f-5a71-4714-8e31-8bc831df7776",
"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": "2025-10-09T20:13:03.211273+00:00"
},
"modified_dateutc": "2025-10-09T20:13:03.2425339+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f55f4976-28cd-4701-9d43-8aed65dc94df",
"date_reported_by_company": "2025-10-09T20:13:03.2425339+00:00",
"id2": 36,
"company_id": "39a10858-0a2a-41aa-ad22-ff4ae21e151d",
"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": "fb59906a-3b25-4ab2-a1f2-9d82da6d343e",
"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": "2025-10-09T20:13:03.2425339+00:00"
},
"work_instruction_details_id": "977ea895-1c18-4a7c-9bf4-d2610234af07",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a91326b3-804f-4d20-9143-2660ef116d09",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "53990e0a-afd3-49dd-8aac-e323795145de",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-10-09T20:13:03.2425339+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": "6c310069-7406-414f-970e-58025401420c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-10-09T20:13:03.2425339+00:00"
}