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": "5c3dfb9c-e7dc-4db9-aaae-eba37612d13d",
"jobs_id": "042412c5-d722-4e49-9b7f-30c6aafc1f1b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a7fa9b52-f73b-41fc-a4e3-5a4e87246e58",
"_parent_id": "40d1e50f-1738-4a37-ad3c-3b776f423bc1",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e108842e-66f5-4d7d-88d6-6ab05918be9d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5fc20e28-d45e-4e76-8661-5bd383022bd9",
"_parent_id": "b6a08ff2-8bca-4c10-a1a7-590736521494",
"root_parent_id": "5739f1bd-e609-411e-be49-d9edddef5c5d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e86e4cc1-35c9-4a11-a083-4e5965008c63",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "da892256-d8d5-4559-bb88-d2553c4710d9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e9e958e1-972f-4b40-8074-a3e158f02d9e",
"_parent_code": "sample string 6",
"sales_organization_id": "d1fdea26-96dd-46b8-ae63-fdb24f3c4219",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1947935d-1ad9-4214-a715-c9b36570fd55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5dcef3b4-4a3f-436c-9c51-5e2714a7780e",
"db_currency_id": "f0656361-da68-49b1-9645-c554e36e3796",
"db_language_id": "4d4736e8-347a-450d-9441-ac77b0928a45",
"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": "2025-08-04T12:04:49.9222428+00:00"
},
"modified_dateutc": "2025-08-04T12:04:49.9222428+00:00"
},
"equipment_model_id": "c65796c9-c841-47e1-bc7f-f24b2490c93e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fe37b82e-ed2b-40ca-bae8-f5d569b24ce6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "715114a0-ae75-45c6-a733-8b3bb76a0399",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9cfe4282-1562-4118-9ac5-d35a8739c77f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "eaa3ee9d-f82e-42da-8fbb-b71b88a197a1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1947935d-1ad9-4214-a715-c9b36570fd55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5dcef3b4-4a3f-436c-9c51-5e2714a7780e",
"db_currency_id": "f0656361-da68-49b1-9645-c554e36e3796",
"db_language_id": "4d4736e8-347a-450d-9441-ac77b0928a45",
"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": "2025-08-04T12:04:49.9222428+00:00"
},
"modified_dateutc": "2025-08-04T12:04:49.9222428+00:00"
},
"equipment_family_id": "88053ff0-0bc2-4283-8cdb-69655b3fdaa1",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "da892256-d8d5-4559-bb88-d2553c4710d9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e9e958e1-972f-4b40-8074-a3e158f02d9e",
"_parent_code": "sample string 6",
"sales_organization_id": "d1fdea26-96dd-46b8-ae63-fdb24f3c4219",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1947935d-1ad9-4214-a715-c9b36570fd55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5dcef3b4-4a3f-436c-9c51-5e2714a7780e",
"db_currency_id": "f0656361-da68-49b1-9645-c554e36e3796",
"db_language_id": "4d4736e8-347a-450d-9441-ac77b0928a45",
"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": "2025-08-04T12:04:49.9222428+00:00"
},
"modified_dateutc": "2025-08-04T12:04:49.9222428+00:00"
},
"date_in_production_since": "2025-08-04T12:04:49.9222428+00:00",
"date_out_of_production_since": "2025-08-04T12:04:49.9222428+00:00",
"date_end_support": "2025-08-04T12:04:49.9222428+00:00",
"sales_organization_id": "74910a29-2451-44bf-b59a-ca9257644d40",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1947935d-1ad9-4214-a715-c9b36570fd55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5dcef3b4-4a3f-436c-9c51-5e2714a7780e",
"db_currency_id": "f0656361-da68-49b1-9645-c554e36e3796",
"db_language_id": "4d4736e8-347a-450d-9441-ac77b0928a45",
"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": "2025-08-04T12:04:49.9222428+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": "2025-08-04T12:04:49.9222428+00:00"
},
"project_status_id": "2e193ca7-7ca7-469f-ade1-b0ac076c65a2",
"project_status_code": "sample string 10",
"project_status": {
"id": "21f7ab8c-daf5-4643-9bcf-c3618273296b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9091f021-6307-41d4-bfb5-16e935dbf409",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1947935d-1ad9-4214-a715-c9b36570fd55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5dcef3b4-4a3f-436c-9c51-5e2714a7780e",
"db_currency_id": "f0656361-da68-49b1-9645-c554e36e3796",
"db_language_id": "4d4736e8-347a-450d-9441-ac77b0928a45",
"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": "2025-08-04T12:04:49.9222428+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-08-04T12:04:49.9222428+00:00"
},
"company_id": "ed122f15-3129-4785-b21d-ca6951898ba2",
"company_code": "sample string 12",
"db_address_id": "aa2761f7-d205-44ad-9572-298fc29826aa",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9e683b62-4e85-47ec-b14c-38d12e1af179",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0086e16a-2292-40e4-b621-7ae83dd466e5",
"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": "2025-08-04T12:04:49.9222428+00:00",
"date_create": "2025-08-04T12:04:49.9222428+00:00",
"date_update": "2025-08-04T12:04:49.9222428+00:00",
"updated_by_user_id": "4e32b366-7805-4d12-abd5-168fdf1ec51b",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-08-04T12:04:49.9222428+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": "2025-08-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-08-04T12:04:49.9222428+00:00",
"date_last_job": "2025-08-04T12:04:49.9222428+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-08-04T12:04:49.9222428+00:00",
"modified_dateutc": "2025-08-04T12:04:49.9222428+00:00",
"is_mobile_installation": true
},
"job_type_id": "b7f64b96-1177-418b-9a85-eb62449a1b48",
"job_type_code": "sample string 7",
"job_type": {
"id": "4e7f2c00-b980-45d3-a3dc-035a73f08a47",
"name": "sample string 2",
"sales_organization_id": "85699008-0096-49ee-b0e4-a259cb36160f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-08-04T12:04:49.9222428+00:00",
"code": "sample string 7"
},
"job_priority_id": "c3d819c7-1a92-43fd-a329-90b31a35908a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "638a2fa2-dbb8-4280-8834-c180b6024f17",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "501af2eb-114e-4afa-b8a4-acb63e82c534",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1947935d-1ad9-4214-a715-c9b36570fd55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5dcef3b4-4a3f-436c-9c51-5e2714a7780e",
"db_currency_id": "f0656361-da68-49b1-9645-c554e36e3796",
"db_language_id": "4d4736e8-347a-450d-9441-ac77b0928a45",
"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": "2025-08-04T12:04:49.9222428+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-08-04T12:04:49.9222428+00:00"
},
"job_status_id": "5fddfe3a-a9d4-4fed-a09d-34333796ed33",
"job_status_code": "sample string 11",
"db_address_id": "292c069f-d7b8-4744-a6ee-b7ff4c4a18ec",
"contact_id": "ec4ffafa-3e74-4cc0-9503-41a39bffb9a2",
"requested_by_company_id": "b567d906-9f89-4a57-9b99-e7852c0a199a",
"requested_by_contact_id": "ca65403d-76e5-4ec7-a43c-868ac050a57e",
"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": "2025-08-04T12:04:49.9378681+00:00",
"due_date": "2025-08-04T12:04:49.9378681+00:00",
"date_create": "2025-08-04T12:04:49.9378681+00:00",
"date_update": "2025-08-04T12:04:49.9378681+00:00",
"date_closed": "2025-08-04T12:04:49.9378681+00:00",
"suggested_user_id": "91dfc8a6-bc31-4500-a607-68787117675d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "461ee165-dc16-4c71-9956-5a81847cb0fd",
"db_language_id": "b2affcfe-f884-4252-9bdb-3be95ca0b3ad",
"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": "2025-08-04T12:04:49.9378681+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c47ce67a-56df-4143-90f7-5b55b7ef6af5",
"sales_organization": {
"id": "1947935d-1ad9-4214-a715-c9b36570fd55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5dcef3b4-4a3f-436c-9c51-5e2714a7780e",
"db_currency_id": "f0656361-da68-49b1-9645-c554e36e3796",
"db_language_id": "4d4736e8-347a-450d-9441-ac77b0928a45",
"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": "2025-08-04T12:04:49.9222428+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "88d0fe8c-3b20-406b-81c3-fcc379d5369e",
"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": "f75beadd-1920-4e39-b5d9-a16919884fc5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-08-04T12:04:49.9378681+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "27f6f69b-e194-4361-a7ff-cd0d292f2864"
},
"suggested_date_start": "2025-08-04T12:04:49.9378681+00:00",
"skill_id": "0d567507-eaf4-438e-9be0-c15a0e0077bb",
"skill_code": "sample string 32",
"skill": {
"id": "1a3513ff-9fbb-4dfc-9aef-4ee90a343fff",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f5767828-fc76-487c-866c-8f9415cf45f0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1947935d-1ad9-4214-a715-c9b36570fd55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5dcef3b4-4a3f-436c-9c51-5e2714a7780e",
"db_currency_id": "f0656361-da68-49b1-9645-c554e36e3796",
"db_language_id": "4d4736e8-347a-450d-9441-ac77b0928a45",
"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": "2025-08-04T12:04:49.9222428+00:00"
},
"modified_dateutc": "2025-08-04T12:04:49.9378681+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "86962100-6379-4d70-832d-99bfc867cb0e",
"date_reported_by_company": "2025-08-04T12:04:49.9378681+00:00",
"id2": 36,
"company_id": "72de2c55-1134-46d4-9f6d-a8e93c3e6207",
"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": "b36cce75-ef77-4601-8016-7e0e98ab46f7",
"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": "2025-08-04T12:04:49.9378681+00:00"
},
"work_instruction_details_id": "084daf4c-bc6c-461d-906c-05cf0a7f178e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1f2ad40b-8b19-4d63-ace3-4b7cb50addd5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1a2460e5-a60c-4b28-8fc1-62f562d1eaff",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-08-04T12:04:49.9378681+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": "ff93a9b1-8e2e-4531-ac04-117dd0665659",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-08-04T12:04:49.9378681+00:00"
}