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": "ea10d94e-3e25-4a77-9d69-d2b7bd8c2c37",
"jobs_id": "1b28cb2b-be12-4b63-9884-cfd1d70a22a2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "09bf4ab6-a5c1-45c7-b467-d1f7ef072a8e",
"_parent_id": "31553276-699b-49b8-ba0f-7c9585ee34c3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9b0a6946-603a-4298-8eac-1455dd330c91",
"project_reference_back_office": "sample string 5",
"project": {
"id": "47327b1e-41ac-4a51-bf0b-049fb7dbec52",
"_parent_id": "154588b8-cf03-4df6-a086-ed3894547d49",
"root_parent_id": "1640ef12-4dee-40fa-8171-07ff3bebee12",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "735aa7e7-1c52-4467-bb99-bfcc07b62597",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "00e7855d-68eb-4e53-8ce0-eb5aa8167b27",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d2fc1b4f-5498-4a6d-a0a7-fc6fcd74b4f7",
"_parent_code": "sample string 6",
"sales_organization_id": "81095cc0-8df6-47b3-b020-fe27e7f8922d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1b5650cf-3c1c-400a-98e5-f8f1b827163d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5127ac40-573d-43d6-8644-3b9fc12c5e8d",
"db_currency_id": "74b31029-bee7-4369-b23b-a14c2bf2b7f5",
"db_language_id": "372b0733-f3a4-40dd-b117-45b2bfb0d8be",
"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-10-12T07:43:05.3108317+00:00"
},
"modified_dateutc": "2026-10-12T07:43:05.3108317+00:00"
},
"equipment_model_id": "c56d9e24-bcb5-48ff-a9e1-d60108831a56",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "93b3f634-e10d-4e9f-9947-0f054c5d34ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b2c38a91-cbf1-440e-8db0-6d55eabc6f57",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9a3c840d-8eac-4d9b-a064-6d945f253955",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "90d63d38-97d5-4c50-a228-4ad685a30b1a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1b5650cf-3c1c-400a-98e5-f8f1b827163d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5127ac40-573d-43d6-8644-3b9fc12c5e8d",
"db_currency_id": "74b31029-bee7-4369-b23b-a14c2bf2b7f5",
"db_language_id": "372b0733-f3a4-40dd-b117-45b2bfb0d8be",
"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-10-12T07:43:05.3108317+00:00"
},
"modified_dateutc": "2026-10-12T07:43:05.3304793+00:00"
},
"equipment_family_id": "3858cec1-0adb-4c48-97ec-466d9fa2d55d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "00e7855d-68eb-4e53-8ce0-eb5aa8167b27",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d2fc1b4f-5498-4a6d-a0a7-fc6fcd74b4f7",
"_parent_code": "sample string 6",
"sales_organization_id": "81095cc0-8df6-47b3-b020-fe27e7f8922d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1b5650cf-3c1c-400a-98e5-f8f1b827163d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5127ac40-573d-43d6-8644-3b9fc12c5e8d",
"db_currency_id": "74b31029-bee7-4369-b23b-a14c2bf2b7f5",
"db_language_id": "372b0733-f3a4-40dd-b117-45b2bfb0d8be",
"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-10-12T07:43:05.3108317+00:00"
},
"modified_dateutc": "2026-10-12T07:43:05.3108317+00:00"
},
"date_in_production_since": "2026-10-12T07:43:05.3304793+00:00",
"date_out_of_production_since": "2026-10-12T07:43:05.3304793+00:00",
"date_end_support": "2026-10-12T07:43:05.3304793+00:00",
"sales_organization_id": "9530d8b5-0e11-4abb-a3c7-157ae16a6f81",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1b5650cf-3c1c-400a-98e5-f8f1b827163d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5127ac40-573d-43d6-8644-3b9fc12c5e8d",
"db_currency_id": "74b31029-bee7-4369-b23b-a14c2bf2b7f5",
"db_language_id": "372b0733-f3a4-40dd-b117-45b2bfb0d8be",
"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-10-12T07:43:05.3108317+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-10-12T07:43:05.3304793+00:00"
},
"project_status_id": "743c76f2-bb35-4f42-a1b0-f91fb8479397",
"project_status_code": "sample string 10",
"project_status": {
"id": "1bab3da6-14d0-42c5-b642-3db1c344b842",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "34d9d9a1-715e-449e-95ce-85453b7e7046",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1b5650cf-3c1c-400a-98e5-f8f1b827163d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5127ac40-573d-43d6-8644-3b9fc12c5e8d",
"db_currency_id": "74b31029-bee7-4369-b23b-a14c2bf2b7f5",
"db_language_id": "372b0733-f3a4-40dd-b117-45b2bfb0d8be",
"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-10-12T07:43:05.3108317+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-12T07:43:05.3304793+00:00"
},
"company_id": "19793e3e-817a-4c36-ae0a-ef10b5489b50",
"company_code": "sample string 12",
"db_address_id": "8bde6534-5538-4be9-8c2d-185e91012ecd",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c2439162-117c-4992-854a-9d6ea18315db",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "70593adc-c4d8-42c6-9f8d-b63374bde017",
"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-10-12T07:43:05.3304793+00:00",
"date_create": "2026-10-12T07:43:05.3304793+00:00",
"date_update": "2026-10-12T07:43:05.3304793+00:00",
"updated_by_user_id": "15a76fa7-1928-4a47-8204-33a3f004d8a4",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-12T07:43:05.3304793+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-10-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-12T07:43:05.3304793+00:00",
"date_last_job": "2026-10-12T07:43:05.3304793+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-12T07:43:05.3304793+00:00",
"modified_dateutc": "2026-10-12T07:43:05.3304793+00:00",
"is_mobile_installation": true
},
"job_type_id": "5a81f597-936c-4304-af1f-50f2a2a9ab31",
"job_type_code": "sample string 7",
"job_type": {
"id": "4e48d2e1-2d46-4efe-910e-d4a4bf4328f9",
"name": "sample string 2",
"sales_organization_id": "b10cebef-7d56-458c-9c5a-89b97aa9598c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-12T07:43:05.3304793+00:00",
"code": "sample string 7"
},
"job_priority_id": "e3d279c9-88f2-4d68-91c2-55a92a83738d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e19de5b6-7b48-4684-8814-f89129e4c7c1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "41d882ec-c7d4-43f7-836d-d61837a56e7c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1b5650cf-3c1c-400a-98e5-f8f1b827163d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5127ac40-573d-43d6-8644-3b9fc12c5e8d",
"db_currency_id": "74b31029-bee7-4369-b23b-a14c2bf2b7f5",
"db_language_id": "372b0733-f3a4-40dd-b117-45b2bfb0d8be",
"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-10-12T07:43:05.3108317+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-12T07:43:05.3304793+00:00"
},
"job_status_id": "4c8aae35-10b1-43a1-a8c4-cc061e8af6d0",
"job_status_code": "sample string 11",
"db_address_id": "a46b755f-d0c1-4638-9735-3dda7deeea06",
"contact_id": "99fb49e7-1311-4667-b548-715f1da37263",
"requested_by_company_id": "dbd7aa8f-b2b8-4b55-9623-a461228d6a23",
"requested_by_contact_id": "1fa347c4-9d56-4657-9dff-195b3f6977c8",
"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-10-12T07:43:05.3304793+00:00",
"due_date": "2026-10-12T07:43:05.3304793+00:00",
"date_create": "2026-10-12T07:43:05.3304793+00:00",
"date_update": "2026-10-12T07:43:05.3304793+00:00",
"date_closed": "2026-10-12T07:43:05.3304793+00:00",
"suggested_user_id": "766b57c3-4d04-4ee4-9ae9-54f38120edab",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "94d6b007-ea03-4bf4-85b5-9964a2c8f290",
"db_language_id": "72ae61eb-86c5-4844-820e-3ee27df33a86",
"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-10-12T07:43:05.3304793+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a450507f-fb2d-47dd-974b-fa0f0a134304",
"sales_organization": {
"id": "1b5650cf-3c1c-400a-98e5-f8f1b827163d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5127ac40-573d-43d6-8644-3b9fc12c5e8d",
"db_currency_id": "74b31029-bee7-4369-b23b-a14c2bf2b7f5",
"db_language_id": "372b0733-f3a4-40dd-b117-45b2bfb0d8be",
"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-10-12T07:43:05.3108317+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6f222a04-5891-4fc5-9c25-0e78b87f24c9",
"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": "feab33f4-ec0d-45a7-9faa-e90274097d9f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-12T07:43:05.3304793+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ec795a7e-4a9b-4423-acad-bf43251aa5e7"
},
"suggested_date_start": "2026-10-12T07:43:05.3304793+00:00",
"skill_id": "be0dc990-1fa8-4a30-95eb-cdf688d4883e",
"skill_code": "sample string 32",
"skill": {
"id": "18c7b244-7e7a-4be1-a6d7-23a63ebfc9b4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "bdbfa313-2d27-4e4c-98d1-8fa4a828571a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1b5650cf-3c1c-400a-98e5-f8f1b827163d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5127ac40-573d-43d6-8644-3b9fc12c5e8d",
"db_currency_id": "74b31029-bee7-4369-b23b-a14c2bf2b7f5",
"db_language_id": "372b0733-f3a4-40dd-b117-45b2bfb0d8be",
"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-10-12T07:43:05.3108317+00:00"
},
"modified_dateutc": "2026-10-12T07:43:05.3304793+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5d769dd8-e8e0-4276-8c92-ca15b925ce37",
"date_reported_by_company": "2026-10-12T07:43:05.3304793+00:00",
"id2": 36,
"company_id": "0236f842-8127-43df-af14-0f44c42753fc",
"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": "62a35703-8d22-4ae0-8c69-62731f59d7a2",
"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-10-12T07:43:05.3304793+00:00"
},
"work_instruction_details_id": "72f7f37a-bde8-4d98-8c1d-ad05bf9453d3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "00674fcb-9b9b-43dd-aba4-a0a15fec7381",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a0bbe343-8a14-47be-8d52-f7032a152570",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-12T07:43:05.3304793+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": "a98e284c-6a16-47ec-b006-c61c11e1cd0d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-12T07:43:05.3415555+00:00"
}