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": "8724582d-afe8-46e4-b837-ae353e02d7b9",
"jobs_id": "ca27294b-69d0-402a-ac1d-28d7bde1fcb5",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "009cb572-040b-44c8-b864-7f7334019aae",
"_parent_id": "2ba9e599-8ba5-49e8-a88b-7567d049842d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "360aa49a-ace9-476d-b0ce-e2dd55e4d12b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e9c4feb0-72b2-4b59-aef2-9db24cc04a83",
"_parent_id": "a1f753ea-e53f-47f2-a587-68adbeb68bf5",
"root_parent_id": "edf720a3-0a56-409d-b704-5c55fc9ccc15",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "97ba8ba1-e681-4f6a-8a22-6a2ffbd4f9cc",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1e943bae-c398-4705-b74a-4b4d7093e665",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0890d474-2af8-45ea-a162-ac8b61439570",
"_parent_code": "sample string 6",
"sales_organization_id": "0e25bab7-1a10-4099-befb-f974987b2f0e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "44d4d482-2886-432e-b1c7-06bcdde4cdba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1579a6c0-58dd-4348-8c63-3e2cffd95b1d",
"db_currency_id": "25f27c7c-4a12-4140-b099-aff8cdbee077",
"db_language_id": "1ef18b8c-77e7-4251-abf4-027b64e50629",
"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-05-13T10:26:08.2231108+00:00"
},
"modified_dateutc": "2026-05-13T10:26:08.2231108+00:00"
},
"equipment_model_id": "36db7b48-a0c8-4645-9c74-9a1816b5507b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "afcc048f-0d7c-4c91-82fd-7f9353587d1c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7060d360-011f-4df4-8836-4b33cf864427",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b26393d0-c408-4266-b9b0-8690114e95ee",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0f99523f-7adb-412a-b380-7d0da8834db0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "44d4d482-2886-432e-b1c7-06bcdde4cdba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1579a6c0-58dd-4348-8c63-3e2cffd95b1d",
"db_currency_id": "25f27c7c-4a12-4140-b099-aff8cdbee077",
"db_language_id": "1ef18b8c-77e7-4251-abf4-027b64e50629",
"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-05-13T10:26:08.2231108+00:00"
},
"modified_dateutc": "2026-05-13T10:26:08.2231108+00:00"
},
"equipment_family_id": "f7ef33d6-834f-49ae-bec4-31986e8a37dc",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1e943bae-c398-4705-b74a-4b4d7093e665",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0890d474-2af8-45ea-a162-ac8b61439570",
"_parent_code": "sample string 6",
"sales_organization_id": "0e25bab7-1a10-4099-befb-f974987b2f0e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "44d4d482-2886-432e-b1c7-06bcdde4cdba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1579a6c0-58dd-4348-8c63-3e2cffd95b1d",
"db_currency_id": "25f27c7c-4a12-4140-b099-aff8cdbee077",
"db_language_id": "1ef18b8c-77e7-4251-abf4-027b64e50629",
"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-05-13T10:26:08.2231108+00:00"
},
"modified_dateutc": "2026-05-13T10:26:08.2231108+00:00"
},
"date_in_production_since": "2026-05-13T10:26:08.2231108+00:00",
"date_out_of_production_since": "2026-05-13T10:26:08.2231108+00:00",
"date_end_support": "2026-05-13T10:26:08.2231108+00:00",
"sales_organization_id": "e1568660-18e2-432f-802e-f6f127f42ead",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "44d4d482-2886-432e-b1c7-06bcdde4cdba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1579a6c0-58dd-4348-8c63-3e2cffd95b1d",
"db_currency_id": "25f27c7c-4a12-4140-b099-aff8cdbee077",
"db_language_id": "1ef18b8c-77e7-4251-abf4-027b64e50629",
"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-05-13T10:26:08.2231108+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-05-13T10:26:08.2231108+00:00"
},
"project_status_id": "0ce15147-6cf5-4ea7-964f-766752e22df4",
"project_status_code": "sample string 10",
"project_status": {
"id": "00f2e7d0-71f2-4718-874b-09981b6092db",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "de54e8e2-3860-47cb-afd7-60c85198aedb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "44d4d482-2886-432e-b1c7-06bcdde4cdba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1579a6c0-58dd-4348-8c63-3e2cffd95b1d",
"db_currency_id": "25f27c7c-4a12-4140-b099-aff8cdbee077",
"db_language_id": "1ef18b8c-77e7-4251-abf4-027b64e50629",
"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-05-13T10:26:08.2231108+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-13T10:26:08.2231108+00:00"
},
"company_id": "7ef89746-f568-49f2-a80e-5d2225afca99",
"company_code": "sample string 12",
"db_address_id": "ff61fa04-d6dd-4db8-b730-6c125489d573",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2dd46e45-3d50-4747-9a96-57605363a456",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "fe837ff5-6b82-44ed-b081-cad3909bdc75",
"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-05-13T10:26:08.2231108+00:00",
"date_create": "2026-05-13T10:26:08.2231108+00:00",
"date_update": "2026-05-13T10:26:08.2231108+00:00",
"updated_by_user_id": "5e320d4f-c583-4cea-808b-2de000a39e50",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-13T10:26:08.2231108+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-05-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-13T10:26:08.2231108+00:00",
"date_last_job": "2026-05-13T10:26:08.2231108+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-13T10:26:08.2231108+00:00",
"modified_dateutc": "2026-05-13T10:26:08.2231108+00:00",
"is_mobile_installation": true
},
"job_type_id": "0cd96a76-fff6-482f-aecc-fe3ed9de6ba2",
"job_type_code": "sample string 7",
"job_type": {
"id": "6c7c4534-4fa5-4ad1-83db-2e3c7df6b7b8",
"name": "sample string 2",
"sales_organization_id": "108ca8d1-f562-41a7-96c5-5b9d6611886f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-13T10:26:08.2231108+00:00",
"code": "sample string 7"
},
"job_priority_id": "32f63371-a768-494f-ab0e-8f9ef5181362",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "219689eb-c032-4c9e-99d0-f888d31381ff",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "38d8cad5-4c34-4fa0-8b8e-f77f9acb1d2c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "44d4d482-2886-432e-b1c7-06bcdde4cdba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1579a6c0-58dd-4348-8c63-3e2cffd95b1d",
"db_currency_id": "25f27c7c-4a12-4140-b099-aff8cdbee077",
"db_language_id": "1ef18b8c-77e7-4251-abf4-027b64e50629",
"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-05-13T10:26:08.2231108+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-13T10:26:08.2231108+00:00"
},
"job_status_id": "7f2f4d38-eff0-44da-8cee-9b287080fbac",
"job_status_code": "sample string 11",
"db_address_id": "9617d0a3-6cc0-4766-8cfb-327172b7172e",
"contact_id": "8f67cd71-c91f-47de-a6fc-ffa2e15b9018",
"requested_by_company_id": "6d460fc0-327c-4785-ab08-7a62c938d1a6",
"requested_by_contact_id": "8d260de7-db95-4c3e-a2b7-11af9e096704",
"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-05-13T10:26:08.2231108+00:00",
"due_date": "2026-05-13T10:26:08.2231108+00:00",
"date_create": "2026-05-13T10:26:08.2231108+00:00",
"date_update": "2026-05-13T10:26:08.2231108+00:00",
"date_closed": "2026-05-13T10:26:08.2231108+00:00",
"suggested_user_id": "f592ebb7-053a-4e4f-aea2-e5e7b263ea0b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f5497cc6-0632-46aa-b6fd-eb5fa6fa94ea",
"db_language_id": "8948e4fd-bcf5-45dd-9e34-8eba8f9d6dcd",
"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-05-13T10:26:08.2231108+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "01cae7cf-e16c-49a4-afe7-d42fead2f5ff",
"sales_organization": {
"id": "44d4d482-2886-432e-b1c7-06bcdde4cdba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1579a6c0-58dd-4348-8c63-3e2cffd95b1d",
"db_currency_id": "25f27c7c-4a12-4140-b099-aff8cdbee077",
"db_language_id": "1ef18b8c-77e7-4251-abf4-027b64e50629",
"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-05-13T10:26:08.2231108+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7bb4e531-8ebd-4ec7-a9da-24a54ab9cc03",
"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": "82ac4c7b-2246-4d88-b4cc-657e810f7589",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-13T10:26:08.2231108+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "352ceb2a-efcf-4f6a-98b9-3d7f1da6e793"
},
"suggested_date_start": "2026-05-13T10:26:08.2231108+00:00",
"skill_id": "1266fc84-3276-492c-a39a-cd9361122ed2",
"skill_code": "sample string 32",
"skill": {
"id": "2ada70e6-caad-4d4b-b143-11d8aefc2472",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5b626334-a588-4e43-bb1f-2127c9e8de2f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "44d4d482-2886-432e-b1c7-06bcdde4cdba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1579a6c0-58dd-4348-8c63-3e2cffd95b1d",
"db_currency_id": "25f27c7c-4a12-4140-b099-aff8cdbee077",
"db_language_id": "1ef18b8c-77e7-4251-abf4-027b64e50629",
"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-05-13T10:26:08.2231108+00:00"
},
"modified_dateutc": "2026-05-13T10:26:08.2231108+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "56b9603e-fb32-4342-a6c6-27e8b8caeaeb",
"date_reported_by_company": "2026-05-13T10:26:08.2231108+00:00",
"id2": 36,
"company_id": "c6a101d0-c8e4-4b76-af18-feb3231e5a42",
"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": "b4f1b854-367a-459e-ad73-f9aae34e7c20",
"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-05-13T10:26:08.2231108+00:00"
},
"work_instruction_details_id": "e3c90f37-cbeb-48f6-944b-c3ee9a16b4ae",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a57f2292-c6dd-48e9-80d2-3f043e463ecb",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d0250f4f-10a1-4edc-bb9d-f5ea41b66bf6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-13T10:26:08.2231108+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": "d29b2877-e6e0-4279-9248-a290d172acad",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-13T10:26:08.2231108+00:00"
}