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": "fbb3f36d-623c-4fe4-a367-ba6605eb1797",
"jobs_id": "675ed119-c33b-436a-9011-9e4e670af6ac",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "be972334-0774-45bf-b2ef-ef23cde46173",
"_parent_id": "3c6d237d-a50e-44ea-88d1-e99c89c880b9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a2382425-b485-48c1-8c3c-58a1f7f5c3f0",
"project_reference_back_office": "sample string 5",
"project": {
"id": "63977c73-2437-4f42-a941-f4217a1461b6",
"_parent_id": "7552ee24-ef25-44c8-b764-f4829911e37e",
"root_parent_id": "9fc05158-73aa-4efd-9a52-062837d61489",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "cae66655-6425-4926-98f1-3f335abfdd78",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e95e7344-71d6-44fd-b1be-7b292d3c63be",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4b06b538-12b8-473a-bcb1-0ce486bd6193",
"_parent_code": "sample string 6",
"sales_organization_id": "eb3e12db-de8f-4557-a3db-238806058ed0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "16a939a5-9f0f-4aab-b0ce-6f369d44d19b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "46718b67-6fb9-4821-9fac-4fc9debda2d9",
"db_currency_id": "9531a95a-7aa8-46ab-b08e-dc981279a88d",
"db_language_id": "041a7eb1-fddc-4cc7-9661-6af3de1cd0c0",
"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-08-06T05:17:58.4427793+00:00"
},
"modified_dateutc": "2026-08-06T05:17:58.4427793+00:00"
},
"equipment_model_id": "8f0ef5a1-13e8-4c48-81b0-9ea5c9a43cf0",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5fe22590-e535-43c5-b8f6-e30ce28c7300",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5ab67477-6064-42f2-94f4-fd74cb2cef9b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a73ee49d-b991-4759-afaa-0b21f1b832a1",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "85f3f8cf-12e1-4d30-8de7-7cf90249598d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "16a939a5-9f0f-4aab-b0ce-6f369d44d19b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "46718b67-6fb9-4821-9fac-4fc9debda2d9",
"db_currency_id": "9531a95a-7aa8-46ab-b08e-dc981279a88d",
"db_language_id": "041a7eb1-fddc-4cc7-9661-6af3de1cd0c0",
"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-08-06T05:17:58.4427793+00:00"
},
"modified_dateutc": "2026-08-06T05:17:58.4427793+00:00"
},
"equipment_family_id": "968dda37-1607-4e2e-bf68-05b9ac17900d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e95e7344-71d6-44fd-b1be-7b292d3c63be",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4b06b538-12b8-473a-bcb1-0ce486bd6193",
"_parent_code": "sample string 6",
"sales_organization_id": "eb3e12db-de8f-4557-a3db-238806058ed0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "16a939a5-9f0f-4aab-b0ce-6f369d44d19b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "46718b67-6fb9-4821-9fac-4fc9debda2d9",
"db_currency_id": "9531a95a-7aa8-46ab-b08e-dc981279a88d",
"db_language_id": "041a7eb1-fddc-4cc7-9661-6af3de1cd0c0",
"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-08-06T05:17:58.4427793+00:00"
},
"modified_dateutc": "2026-08-06T05:17:58.4427793+00:00"
},
"date_in_production_since": "2026-08-06T05:17:58.4427793+00:00",
"date_out_of_production_since": "2026-08-06T05:17:58.4427793+00:00",
"date_end_support": "2026-08-06T05:17:58.4427793+00:00",
"sales_organization_id": "e70af547-ebe9-4931-a53d-fc9a85a7ebcc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "16a939a5-9f0f-4aab-b0ce-6f369d44d19b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "46718b67-6fb9-4821-9fac-4fc9debda2d9",
"db_currency_id": "9531a95a-7aa8-46ab-b08e-dc981279a88d",
"db_language_id": "041a7eb1-fddc-4cc7-9661-6af3de1cd0c0",
"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-08-06T05:17:58.4427793+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-08-06T05:17:58.4427793+00:00"
},
"project_status_id": "7239eca5-2886-43e2-968f-9a7aa03f1c90",
"project_status_code": "sample string 10",
"project_status": {
"id": "715b2b7a-0441-48db-930d-a60d5b261156",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "772e5fd9-6a08-4570-a06f-76734b5dfabc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "16a939a5-9f0f-4aab-b0ce-6f369d44d19b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "46718b67-6fb9-4821-9fac-4fc9debda2d9",
"db_currency_id": "9531a95a-7aa8-46ab-b08e-dc981279a88d",
"db_language_id": "041a7eb1-fddc-4cc7-9661-6af3de1cd0c0",
"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-08-06T05:17:58.4427793+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-06T05:17:58.4427793+00:00"
},
"company_id": "6ce49165-806f-41b8-a3e0-51aaf9bc3e04",
"company_code": "sample string 12",
"db_address_id": "3cf400a4-cb96-44b2-8be8-376d42de2935",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cc3ffc21-8d67-4e0e-949b-30c2a781aee8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a21780d0-080f-40a1-a3d2-d4326942f65a",
"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-08-06T05:17:58.4427793+00:00",
"date_create": "2026-08-06T05:17:58.4427793+00:00",
"date_update": "2026-08-06T05:17:58.4427793+00:00",
"updated_by_user_id": "c185bfcd-ce21-4893-ae23-c14e4e7789f4",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-06T05:17:58.4427793+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-08-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-06T05:17:58.4427793+00:00",
"date_last_job": "2026-08-06T05:17:58.4427793+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-06T05:17:58.4427793+00:00",
"modified_dateutc": "2026-08-06T05:17:58.4427793+00:00",
"is_mobile_installation": true
},
"job_type_id": "223d5bab-dc52-4169-ac80-07b7f6c139ff",
"job_type_code": "sample string 7",
"job_type": {
"id": "d5e402ff-ac52-4360-8e4d-0cfa82010333",
"name": "sample string 2",
"sales_organization_id": "fe16ec41-8468-427f-a59c-5d853cd27684",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-06T05:17:58.4427793+00:00",
"code": "sample string 7"
},
"job_priority_id": "f836fe75-db5f-4212-88e0-d9a9fd55fc0e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0151b596-3e7e-4c38-a174-d8fb972b2896",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6d4b3d4a-e1d3-432c-9e85-0d1c04ec836e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "16a939a5-9f0f-4aab-b0ce-6f369d44d19b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "46718b67-6fb9-4821-9fac-4fc9debda2d9",
"db_currency_id": "9531a95a-7aa8-46ab-b08e-dc981279a88d",
"db_language_id": "041a7eb1-fddc-4cc7-9661-6af3de1cd0c0",
"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-08-06T05:17:58.4427793+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-06T05:17:58.4427793+00:00"
},
"job_status_id": "a298b77f-3b62-4e8d-bf4c-c536c278a056",
"job_status_code": "sample string 11",
"db_address_id": "33d6cc72-d686-4aac-975f-e26ecdfea4e3",
"contact_id": "c9606834-3183-4ed1-8c46-3024ed7f0e92",
"requested_by_company_id": "4c9945a8-afb9-4cac-bd9d-0e7882faf872",
"requested_by_contact_id": "37ce01ad-76ce-4d72-86af-98630d2aef1e",
"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-08-06T05:17:58.4427793+00:00",
"due_date": "2026-08-06T05:17:58.4427793+00:00",
"date_create": "2026-08-06T05:17:58.4427793+00:00",
"date_update": "2026-08-06T05:17:58.4427793+00:00",
"date_closed": "2026-08-06T05:17:58.4427793+00:00",
"suggested_user_id": "82f4d7c3-a049-446d-baf2-1bdaefb2556a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "50db9b13-9020-4948-b589-1b96f22768d6",
"db_language_id": "4e76487c-3acd-4752-ab43-b933f88f7659",
"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-08-06T05:17:58.4427793+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "716efa7e-7ed9-447d-9c45-70ede5588341",
"sales_organization": {
"id": "16a939a5-9f0f-4aab-b0ce-6f369d44d19b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "46718b67-6fb9-4821-9fac-4fc9debda2d9",
"db_currency_id": "9531a95a-7aa8-46ab-b08e-dc981279a88d",
"db_language_id": "041a7eb1-fddc-4cc7-9661-6af3de1cd0c0",
"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-08-06T05:17:58.4427793+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "51850c65-db38-41da-af37-b4d5b0940f55",
"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": "f06adff7-cbf4-43fd-bc12-2a92d1b845ef",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-06T05:17:58.4427793+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a8cef2c0-898c-42dd-9493-8034935b54f6"
},
"suggested_date_start": "2026-08-06T05:17:58.4427793+00:00",
"skill_id": "23596cb2-812d-4af1-9926-21749e976752",
"skill_code": "sample string 32",
"skill": {
"id": "d2d53c6c-02ee-4b02-a7b8-a7b5e1f4856c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f2787e49-2bd7-4337-a343-e40a6698af6e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "16a939a5-9f0f-4aab-b0ce-6f369d44d19b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "46718b67-6fb9-4821-9fac-4fc9debda2d9",
"db_currency_id": "9531a95a-7aa8-46ab-b08e-dc981279a88d",
"db_language_id": "041a7eb1-fddc-4cc7-9661-6af3de1cd0c0",
"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-08-06T05:17:58.4427793+00:00"
},
"modified_dateutc": "2026-08-06T05:17:58.4427793+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6e3edf40-0fa3-46bc-9704-d105f1118e4d",
"date_reported_by_company": "2026-08-06T05:17:58.4427793+00:00",
"id2": 36,
"company_id": "388c651b-400e-4c29-a20b-1ed5a3f5dd52",
"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": "c5483b7c-7178-4d60-b048-8577c41b1af7",
"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-08-06T05:17:58.4427793+00:00"
},
"work_instruction_details_id": "9eb7d3ca-ef94-402f-b2bb-1740b439b350",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3d947e8a-2fbf-4f5c-a0d2-e3a08b37538f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8f7bbf41-63e1-466b-9ef2-6ad256bbc33e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-06T05:17:58.458405+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": "af202725-d69f-4823-9483-baa37fd41240",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-06T05:17:58.458405+00:00"
}