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": "da2edd0e-8c8f-453a-974a-3957085292bd",
"jobs_id": "da10de71-aa7b-4e7c-91cd-e44f784195a9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4466ccdd-3938-44a5-a9c6-7e745738bf3d",
"_parent_id": "a1624d59-caf4-4282-bd8c-1003660cd41f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8e9f854c-7b16-4221-bf01-866607eebe83",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d14bc0f6-fa07-4378-9fba-017dcf4e72e0",
"_parent_id": "21743dd6-85da-4b5d-989c-c7bbcdb71143",
"root_parent_id": "bb50b320-458f-4e45-a85b-88a04b1b1783",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3fbdedff-0dd6-49fd-b5f4-7bb8e752aef8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "379d400c-4bd0-4e9e-bfe4-4555d6d20df1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "369652c8-87fe-4ad4-96de-5e78040a96ed",
"_parent_code": "sample string 6",
"sales_organization_id": "180287e6-feae-4598-b674-cb9036ed23dc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c3bfa27f-4724-4aff-9310-6b47e037e146",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b70b6a08-075b-41b1-b549-376d4480e869",
"db_currency_id": "527a4263-dd0c-44ce-9c81-d9fc8e0946f5",
"db_language_id": "2af3c890-ea84-4dba-8b61-1dcfe08dbc6b",
"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-09-29T11:55:04.9456883+00:00"
},
"modified_dateutc": "2026-09-29T11:55:04.9456883+00:00"
},
"equipment_model_id": "f930bb7a-ba62-474f-81ee-a83dc006cb57",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b4663109-7b85-4d18-a954-4ec4fc614941",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "99121896-e60b-41c3-a830-f4621f6679fc",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "31e9bc46-2340-47e0-9861-9d8489ff3202",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8183619a-ff33-4c83-b026-039502cda0cf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c3bfa27f-4724-4aff-9310-6b47e037e146",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b70b6a08-075b-41b1-b549-376d4480e869",
"db_currency_id": "527a4263-dd0c-44ce-9c81-d9fc8e0946f5",
"db_language_id": "2af3c890-ea84-4dba-8b61-1dcfe08dbc6b",
"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-09-29T11:55:04.9456883+00:00"
},
"modified_dateutc": "2026-09-29T11:55:04.9456883+00:00"
},
"equipment_family_id": "0e0224a3-3e0f-450c-94a1-ffe3cd9cd2e5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "379d400c-4bd0-4e9e-bfe4-4555d6d20df1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "369652c8-87fe-4ad4-96de-5e78040a96ed",
"_parent_code": "sample string 6",
"sales_organization_id": "180287e6-feae-4598-b674-cb9036ed23dc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c3bfa27f-4724-4aff-9310-6b47e037e146",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b70b6a08-075b-41b1-b549-376d4480e869",
"db_currency_id": "527a4263-dd0c-44ce-9c81-d9fc8e0946f5",
"db_language_id": "2af3c890-ea84-4dba-8b61-1dcfe08dbc6b",
"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-09-29T11:55:04.9456883+00:00"
},
"modified_dateutc": "2026-09-29T11:55:04.9456883+00:00"
},
"date_in_production_since": "2026-09-29T11:55:04.9456883+00:00",
"date_out_of_production_since": "2026-09-29T11:55:04.9456883+00:00",
"date_end_support": "2026-09-29T11:55:04.9456883+00:00",
"sales_organization_id": "7320a539-d3f5-4f64-a24c-e353279fb54f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c3bfa27f-4724-4aff-9310-6b47e037e146",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b70b6a08-075b-41b1-b549-376d4480e869",
"db_currency_id": "527a4263-dd0c-44ce-9c81-d9fc8e0946f5",
"db_language_id": "2af3c890-ea84-4dba-8b61-1dcfe08dbc6b",
"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-09-29T11:55:04.9456883+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-09-29T11:55:04.9456883+00:00"
},
"project_status_id": "74183e09-588e-4f72-890a-a30ccabbda41",
"project_status_code": "sample string 10",
"project_status": {
"id": "5dd527c2-a6a3-4adb-bfa9-99921916eeed",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "86a1cf54-b393-48d2-b9cd-bcb3200c3d82",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c3bfa27f-4724-4aff-9310-6b47e037e146",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b70b6a08-075b-41b1-b549-376d4480e869",
"db_currency_id": "527a4263-dd0c-44ce-9c81-d9fc8e0946f5",
"db_language_id": "2af3c890-ea84-4dba-8b61-1dcfe08dbc6b",
"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-09-29T11:55:04.9456883+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-29T11:55:04.9456883+00:00"
},
"company_id": "1e0b79c2-77a6-4411-948c-10185d154860",
"company_code": "sample string 12",
"db_address_id": "3beff31b-f126-45cd-8a29-259881d9168d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1ab79499-0e58-4ef3-bc6c-c3dfb3f77830",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "453411d9-7642-419f-81e6-08dce05d7236",
"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-09-29T11:55:04.9456883+00:00",
"date_create": "2026-09-29T11:55:04.9456883+00:00",
"date_update": "2026-09-29T11:55:04.9456883+00:00",
"updated_by_user_id": "eda3e287-e08f-4012-b2a0-5793952a6b34",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-29T11:55:04.9456883+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-09-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-29T11:55:04.9456883+00:00",
"date_last_job": "2026-09-29T11:55:04.9456883+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-29T11:55:04.9456883+00:00",
"modified_dateutc": "2026-09-29T11:55:04.9456883+00:00",
"is_mobile_installation": true
},
"job_type_id": "1b19a1fb-6301-4c48-a7ec-1c306aed8636",
"job_type_code": "sample string 7",
"job_type": {
"id": "b580a4f5-deaf-4962-a503-902fac666168",
"name": "sample string 2",
"sales_organization_id": "9cddbeb7-aac8-4d6e-91f9-f2f0c496b201",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-29T11:55:04.9456883+00:00",
"code": "sample string 7"
},
"job_priority_id": "f3a13b8b-bb2d-4837-9df4-e180e6cb7c5b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a06ac36b-2168-4171-91f1-1fb81c28eddf",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "492ab91c-9c33-4bb1-9bdb-de511397225f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c3bfa27f-4724-4aff-9310-6b47e037e146",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b70b6a08-075b-41b1-b549-376d4480e869",
"db_currency_id": "527a4263-dd0c-44ce-9c81-d9fc8e0946f5",
"db_language_id": "2af3c890-ea84-4dba-8b61-1dcfe08dbc6b",
"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-09-29T11:55:04.9456883+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-29T11:55:04.9456883+00:00"
},
"job_status_id": "abb6d744-ed0c-4af8-bddc-fa57ed6784e4",
"job_status_code": "sample string 11",
"db_address_id": "603c8a68-44f5-49d7-9b81-6dcdd4c8cd21",
"contact_id": "09e68251-e828-467b-a9cd-c0e165df94f3",
"requested_by_company_id": "2ecc86c8-239b-4cd2-93a8-94e41fbc670f",
"requested_by_contact_id": "0b55a036-8e00-421a-9a86-4856251d7b8e",
"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-09-29T11:55:04.9456883+00:00",
"due_date": "2026-09-29T11:55:04.9456883+00:00",
"date_create": "2026-09-29T11:55:04.9456883+00:00",
"date_update": "2026-09-29T11:55:04.9456883+00:00",
"date_closed": "2026-09-29T11:55:04.9456883+00:00",
"suggested_user_id": "02d5eacf-45f9-42b3-9447-eb567a8209c5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c0f4264b-0dd2-4636-bf90-501dad159deb",
"db_language_id": "ee1e7461-330d-40fe-8502-a9329534b0fa",
"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-09-29T11:55:04.9456883+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "93ac7ec0-e38a-4d76-ac53-5c08fce3e24e",
"sales_organization": {
"id": "c3bfa27f-4724-4aff-9310-6b47e037e146",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b70b6a08-075b-41b1-b549-376d4480e869",
"db_currency_id": "527a4263-dd0c-44ce-9c81-d9fc8e0946f5",
"db_language_id": "2af3c890-ea84-4dba-8b61-1dcfe08dbc6b",
"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-09-29T11:55:04.9456883+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a06831bd-5616-48c2-88fd-f84c1ba60a39",
"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": "970dfbb5-7e74-455d-a5a4-bff0ae2b5f33",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-29T11:55:04.9456883+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "41d6275b-c4bc-46a3-8f6a-7a092b1700fc"
},
"suggested_date_start": "2026-09-29T11:55:04.9456883+00:00",
"skill_id": "a2667d0b-99a4-4a13-99aa-1115184b4f37",
"skill_code": "sample string 32",
"skill": {
"id": "f0896e94-4570-4c04-8e7e-4bc43932e460",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6889147c-e306-4b90-aa21-5b7b4d4fa82e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c3bfa27f-4724-4aff-9310-6b47e037e146",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b70b6a08-075b-41b1-b549-376d4480e869",
"db_currency_id": "527a4263-dd0c-44ce-9c81-d9fc8e0946f5",
"db_language_id": "2af3c890-ea84-4dba-8b61-1dcfe08dbc6b",
"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-09-29T11:55:04.9456883+00:00"
},
"modified_dateutc": "2026-09-29T11:55:04.9456883+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "91c7ebd7-b529-4f12-bc1f-6a565b8f342c",
"date_reported_by_company": "2026-09-29T11:55:04.9456883+00:00",
"id2": 36,
"company_id": "1d01eaf5-7f2f-40db-a1a9-aeeb32308c06",
"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": "2afbc869-1dc5-4a9d-83f8-c4f06e71cf38",
"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-09-29T11:55:04.9456883+00:00"
},
"work_instruction_details_id": "c11bbcc8-dd46-4ebd-b8f8-7805b888c8bf",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e13c02fa-4f20-4e64-8ad1-c6e30ff001ae",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "268d49a1-296f-4ef4-87f5-29f929564e73",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-29T11:55:04.9456883+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": "e5d790b7-6e0c-47f4-8750-755ec552f9a5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-29T11:55:04.9613089+00:00"
}