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": "63e67d7b-d365-4d81-a518-885b6046ed1f",
"jobs_id": "05f70396-972f-4c6a-8f19-446f6b4bdb99",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "28f6aab2-7a65-4ffa-b066-389ac096e89c",
"_parent_id": "5a9cd9e9-d3d4-4dba-9e16-69b5aa13aa83",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "bd6a2096-ae4b-42fc-b5b2-52886ec6ec1d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "37baf58d-e7f0-4112-9603-c6daf8cd1262",
"_parent_id": "49cc74d7-bac7-4949-bf08-b9a3516e1550",
"root_parent_id": "30893c62-7d77-4135-a2a7-432fef035388",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a6a1e819-8360-422b-8d8f-99c0b605912b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7fc3a65c-3adf-4a4a-8583-3b239333d1c9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e29f99c1-b3ba-4a03-bc7c-493f30698074",
"_parent_code": "sample string 6",
"sales_organization_id": "daf2020f-0776-4f99-aada-ecf265673e2a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2f7cdf4c-6eab-4fc5-a8ed-240d02e117c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ebbecb5c-2ca6-4964-9a33-259fb6aa5c36",
"db_currency_id": "95e72f5d-5119-4c60-8fb7-ede4f95aa1ef",
"db_language_id": "51fb7179-deb2-46c3-a0ce-3a52ef1862d6",
"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-11-07T11:12:48.6638688+00:00"
},
"modified_dateutc": "2026-11-07T11:12:48.6638688+00:00"
},
"equipment_model_id": "1798406c-0ec1-499c-ae92-66c7eb081240",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f1474b33-6bfb-4e1a-b05b-09269f2979eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d9bb62bf-fd04-491b-b31a-ae6c17feb3fb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "bc3d8b7d-f127-4578-9df6-78a104c08035",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d26d4b94-4f31-4fcc-a63d-869df992a1d9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2f7cdf4c-6eab-4fc5-a8ed-240d02e117c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ebbecb5c-2ca6-4964-9a33-259fb6aa5c36",
"db_currency_id": "95e72f5d-5119-4c60-8fb7-ede4f95aa1ef",
"db_language_id": "51fb7179-deb2-46c3-a0ce-3a52ef1862d6",
"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-11-07T11:12:48.6638688+00:00"
},
"modified_dateutc": "2026-11-07T11:12:48.6638688+00:00"
},
"equipment_family_id": "3a4292ee-c643-4184-8253-d83223d5a619",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7fc3a65c-3adf-4a4a-8583-3b239333d1c9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e29f99c1-b3ba-4a03-bc7c-493f30698074",
"_parent_code": "sample string 6",
"sales_organization_id": "daf2020f-0776-4f99-aada-ecf265673e2a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2f7cdf4c-6eab-4fc5-a8ed-240d02e117c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ebbecb5c-2ca6-4964-9a33-259fb6aa5c36",
"db_currency_id": "95e72f5d-5119-4c60-8fb7-ede4f95aa1ef",
"db_language_id": "51fb7179-deb2-46c3-a0ce-3a52ef1862d6",
"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-11-07T11:12:48.6638688+00:00"
},
"modified_dateutc": "2026-11-07T11:12:48.6638688+00:00"
},
"date_in_production_since": "2026-11-07T11:12:48.6638688+00:00",
"date_out_of_production_since": "2026-11-07T11:12:48.6638688+00:00",
"date_end_support": "2026-11-07T11:12:48.6638688+00:00",
"sales_organization_id": "c50b75a5-b7a1-4439-841d-5539d7945589",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2f7cdf4c-6eab-4fc5-a8ed-240d02e117c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ebbecb5c-2ca6-4964-9a33-259fb6aa5c36",
"db_currency_id": "95e72f5d-5119-4c60-8fb7-ede4f95aa1ef",
"db_language_id": "51fb7179-deb2-46c3-a0ce-3a52ef1862d6",
"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-11-07T11:12:48.6638688+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-11-07T11:12:48.6638688+00:00"
},
"project_status_id": "0bb9eb7e-6408-4434-b096-a59eb0541004",
"project_status_code": "sample string 10",
"project_status": {
"id": "6485b5f5-a811-40fb-bba4-30d688593207",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fe657cb7-bb5a-48e6-8331-2efb87c743ad",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2f7cdf4c-6eab-4fc5-a8ed-240d02e117c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ebbecb5c-2ca6-4964-9a33-259fb6aa5c36",
"db_currency_id": "95e72f5d-5119-4c60-8fb7-ede4f95aa1ef",
"db_language_id": "51fb7179-deb2-46c3-a0ce-3a52ef1862d6",
"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-11-07T11:12:48.6638688+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-07T11:12:48.6638688+00:00"
},
"company_id": "9d5505ff-1626-4f38-8baf-c5388bcbfd73",
"company_code": "sample string 12",
"db_address_id": "0cdc4441-896b-4ad1-ad7d-25f56b36d891",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5d900a04-0690-4703-8d8a-320caf0b84be",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "38a890a8-acf0-4e16-af09-b5742a7b6b18",
"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-11-07T11:12:48.6638688+00:00",
"date_create": "2026-11-07T11:12:48.6638688+00:00",
"date_update": "2026-11-07T11:12:48.6638688+00:00",
"updated_by_user_id": "95b79903-e314-47e6-ac25-91c04375832b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-07T11:12:48.6638688+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-11-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-07T11:12:48.6638688+00:00",
"date_last_job": "2026-11-07T11:12:48.6638688+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-07T11:12:48.6638688+00:00",
"modified_dateutc": "2026-11-07T11:12:48.6638688+00:00",
"is_mobile_installation": true
},
"job_type_id": "d51861fe-f2e2-4460-acc8-f3433545bdfa",
"job_type_code": "sample string 7",
"job_type": {
"id": "a5be028c-b67b-429c-8125-9d7eaad3a4cb",
"name": "sample string 2",
"sales_organization_id": "ef862120-2d56-4c1d-9e39-fe213b286d6b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-07T11:12:48.6638688+00:00",
"code": "sample string 7"
},
"job_priority_id": "d04b4640-1f8c-4dab-8bc6-327989fe6223",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "43044604-631a-4919-ab75-e95d3c945608",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "03f47599-dbb8-4e19-a451-4c21fb478279",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2f7cdf4c-6eab-4fc5-a8ed-240d02e117c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ebbecb5c-2ca6-4964-9a33-259fb6aa5c36",
"db_currency_id": "95e72f5d-5119-4c60-8fb7-ede4f95aa1ef",
"db_language_id": "51fb7179-deb2-46c3-a0ce-3a52ef1862d6",
"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-11-07T11:12:48.6638688+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-07T11:12:48.6638688+00:00"
},
"job_status_id": "90a748e3-7552-4403-8eff-20a49078a225",
"job_status_code": "sample string 11",
"db_address_id": "0d6123db-0225-429b-b730-f58027580542",
"contact_id": "b621ad21-8d50-4a4a-bde4-cf8a31a60cdc",
"requested_by_company_id": "1df57547-1131-4788-add5-7f5441c3af6b",
"requested_by_contact_id": "d419c5f9-3914-444d-8d0e-f06d316b8ba5",
"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-11-07T11:12:48.6638688+00:00",
"due_date": "2026-11-07T11:12:48.6638688+00:00",
"date_create": "2026-11-07T11:12:48.6638688+00:00",
"date_update": "2026-11-07T11:12:48.6638688+00:00",
"date_closed": "2026-11-07T11:12:48.6638688+00:00",
"suggested_user_id": "745d4225-14c7-4107-88a0-fb5b17ed48f8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "feee4dd8-a8bb-49d4-9de0-453702a61af7",
"db_language_id": "c7ef05bd-e139-41ee-bbef-500019a8b523",
"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-11-07T11:12:48.6638688+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6c429b40-a4a2-4beb-8e93-8949dc478caf",
"sales_organization": {
"id": "2f7cdf4c-6eab-4fc5-a8ed-240d02e117c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ebbecb5c-2ca6-4964-9a33-259fb6aa5c36",
"db_currency_id": "95e72f5d-5119-4c60-8fb7-ede4f95aa1ef",
"db_language_id": "51fb7179-deb2-46c3-a0ce-3a52ef1862d6",
"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-11-07T11:12:48.6638688+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4dfaeee0-e16c-4c88-ace2-8984f1d310ef",
"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": "33b76b8a-15b8-4b6a-9f2a-01bf3b120b58",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-07T11:12:48.6638688+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e888f343-caf6-4ade-bc4a-40206565e112"
},
"suggested_date_start": "2026-11-07T11:12:48.6638688+00:00",
"skill_id": "8412b708-6fd2-4081-bb6d-be64875b1f19",
"skill_code": "sample string 32",
"skill": {
"id": "be4da092-b538-4916-9d19-ee57507183a8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8bf76e4d-2030-42f2-b454-46d0147913a4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2f7cdf4c-6eab-4fc5-a8ed-240d02e117c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ebbecb5c-2ca6-4964-9a33-259fb6aa5c36",
"db_currency_id": "95e72f5d-5119-4c60-8fb7-ede4f95aa1ef",
"db_language_id": "51fb7179-deb2-46c3-a0ce-3a52ef1862d6",
"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-11-07T11:12:48.6638688+00:00"
},
"modified_dateutc": "2026-11-07T11:12:48.6638688+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "bc74b1a0-a00d-4a0a-a8f9-d95cc7c7c88e",
"date_reported_by_company": "2026-11-07T11:12:48.6638688+00:00",
"id2": 36,
"company_id": "e807adc8-9122-4b1d-ae65-f36a6f67adc0",
"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": "e99487f4-116a-4404-af8f-48210dc73165",
"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-11-07T11:12:48.6638688+00:00"
},
"work_instruction_details_id": "4ed07070-1535-45c8-a4a4-f3e56981ca75",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0af6641c-e0db-4cb0-9249-3d9d2a16eb57",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "dbdf5f20-8ce1-4508-854b-bf22d0a25774",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-07T11:12:48.6638688+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": "529cba3b-5ebf-4290-8f1a-f278c4fdc788",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-07T11:12:48.6638688+00:00"
}