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": "bae12577-eadb-4568-ae1f-8a5573787248",
"jobs_id": "95e52ebc-0cb2-4cce-987d-8abf4f7357c7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2803c9f4-6b21-421c-b27d-9b4285cf1230",
"_parent_id": "bffbf2d9-1270-4016-bc9c-455d38256748",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "188aedca-7636-4c08-a3d8-8795b6da8792",
"project_reference_back_office": "sample string 5",
"project": {
"id": "af8423f6-26f7-46cc-89ac-9bbc2d01f36f",
"_parent_id": "27b95b8b-1d3e-4490-b60f-4f1ee30965f6",
"root_parent_id": "8f6fe601-9cc3-4e1b-9737-a06a083c9cff",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6d67b0c6-eabd-4b5f-b02a-b7e90adba61d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a74f215d-ae4e-4754-8ad3-5c70e9dccc3b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "db6fba23-417b-45fb-9372-62e74472225a",
"_parent_code": "sample string 6",
"sales_organization_id": "ea6afe31-0cdb-4fc5-9d55-fc4845fe7f30",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fe818049-a9a0-4a81-8bd8-d23d61e71b5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b40428a5-92a6-4f98-84b4-5a9cc20a9150",
"db_currency_id": "fb3b0d3b-8b8e-4db3-a619-2022bfec9e38",
"db_language_id": "ba5709a7-fa8f-446d-bcd1-b57f98e78c79",
"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-12-31T21:40:51.073799+00:00"
},
"modified_dateutc": "2025-12-31T21:40:51.073799+00:00"
},
"equipment_model_id": "6ac8d519-efa0-4d30-bb0c-4cd9a8c23597",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f383a613-b27f-42e5-ae1e-a4f00d8542cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5063d2c1-516a-414e-a526-1925334db9b0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3961554b-7f9f-4dda-bac8-75408d31b07a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "34062d7f-1b76-4561-a0ce-6fa71954ce07",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fe818049-a9a0-4a81-8bd8-d23d61e71b5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b40428a5-92a6-4f98-84b4-5a9cc20a9150",
"db_currency_id": "fb3b0d3b-8b8e-4db3-a619-2022bfec9e38",
"db_language_id": "ba5709a7-fa8f-446d-bcd1-b57f98e78c79",
"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-12-31T21:40:51.073799+00:00"
},
"modified_dateutc": "2025-12-31T21:40:51.073799+00:00"
},
"equipment_family_id": "a36fb210-2f57-4684-af29-8747b3644e3e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a74f215d-ae4e-4754-8ad3-5c70e9dccc3b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "db6fba23-417b-45fb-9372-62e74472225a",
"_parent_code": "sample string 6",
"sales_organization_id": "ea6afe31-0cdb-4fc5-9d55-fc4845fe7f30",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fe818049-a9a0-4a81-8bd8-d23d61e71b5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b40428a5-92a6-4f98-84b4-5a9cc20a9150",
"db_currency_id": "fb3b0d3b-8b8e-4db3-a619-2022bfec9e38",
"db_language_id": "ba5709a7-fa8f-446d-bcd1-b57f98e78c79",
"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-12-31T21:40:51.073799+00:00"
},
"modified_dateutc": "2025-12-31T21:40:51.073799+00:00"
},
"date_in_production_since": "2025-12-31T21:40:51.073799+00:00",
"date_out_of_production_since": "2025-12-31T21:40:51.073799+00:00",
"date_end_support": "2025-12-31T21:40:51.073799+00:00",
"sales_organization_id": "b0e65203-dbd4-4655-93de-3fa5361e5464",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fe818049-a9a0-4a81-8bd8-d23d61e71b5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b40428a5-92a6-4f98-84b4-5a9cc20a9150",
"db_currency_id": "fb3b0d3b-8b8e-4db3-a619-2022bfec9e38",
"db_language_id": "ba5709a7-fa8f-446d-bcd1-b57f98e78c79",
"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-12-31T21:40:51.073799+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-12-31T21:40:51.073799+00:00"
},
"project_status_id": "06701e26-066f-404c-bebe-fdaaa2c44d90",
"project_status_code": "sample string 10",
"project_status": {
"id": "1e8c1e8b-6a6c-48ef-8197-87265665fc82",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "76133a19-9cc4-4e03-a4e9-63ac1506aa76",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fe818049-a9a0-4a81-8bd8-d23d61e71b5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b40428a5-92a6-4f98-84b4-5a9cc20a9150",
"db_currency_id": "fb3b0d3b-8b8e-4db3-a619-2022bfec9e38",
"db_language_id": "ba5709a7-fa8f-446d-bcd1-b57f98e78c79",
"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-12-31T21:40:51.073799+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-31T21:40:51.0894002+00:00"
},
"company_id": "11081163-7359-4e17-979d-e9306f561418",
"company_code": "sample string 12",
"db_address_id": "39f29068-c002-48b7-a949-96e0f468dab2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "202458df-0753-4fbf-ba80-5504f1e70b5d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d78ee60f-2b28-42d7-83e3-589bed497f81",
"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-12-31T21:40:51.0894002+00:00",
"date_create": "2025-12-31T21:40:51.0894002+00:00",
"date_update": "2025-12-31T21:40:51.0894002+00:00",
"updated_by_user_id": "50a755ae-e308-40cf-a49e-f263912c073d",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-31T21:40:51.0894002+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-12-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-31T21:40:51.0894002+00:00",
"date_last_job": "2025-12-31T21:40:51.0894002+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-31T21:40:51.0894002+00:00",
"modified_dateutc": "2025-12-31T21:40:51.0894002+00:00",
"is_mobile_installation": true
},
"job_type_id": "186461b8-dda0-4527-b12b-43c4d4f4b2d4",
"job_type_code": "sample string 7",
"job_type": {
"id": "ca69e63b-1935-4996-bf66-a65210a890ce",
"name": "sample string 2",
"sales_organization_id": "e494dd2e-50ea-40b1-8171-2d9c3ed0ce3f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-31T21:40:51.0894002+00:00",
"code": "sample string 7"
},
"job_priority_id": "da2078b7-ebd7-4522-b274-f4821eb40790",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a20aa7ed-4997-4a14-8e22-26e8b39c636a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c846cc4b-c01d-49aa-8c9a-b430de4f3776",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fe818049-a9a0-4a81-8bd8-d23d61e71b5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b40428a5-92a6-4f98-84b4-5a9cc20a9150",
"db_currency_id": "fb3b0d3b-8b8e-4db3-a619-2022bfec9e38",
"db_language_id": "ba5709a7-fa8f-446d-bcd1-b57f98e78c79",
"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-12-31T21:40:51.073799+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-31T21:40:51.0894002+00:00"
},
"job_status_id": "5e27eedc-b4b2-42fb-b20f-6619d6fd2712",
"job_status_code": "sample string 11",
"db_address_id": "703e3018-063f-4e06-acd4-64af86f5fca2",
"contact_id": "a3b76103-776d-4af7-a3ff-ebc6ae29061a",
"requested_by_company_id": "c3b77258-3d31-4f7f-853d-d57173fd3426",
"requested_by_contact_id": "557704ce-4163-470f-930c-956c5d37c4a1",
"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-12-31T21:40:51.0894002+00:00",
"due_date": "2025-12-31T21:40:51.0894002+00:00",
"date_create": "2025-12-31T21:40:51.0894002+00:00",
"date_update": "2025-12-31T21:40:51.0894002+00:00",
"date_closed": "2025-12-31T21:40:51.0894002+00:00",
"suggested_user_id": "8beea42b-3685-4bbd-a1d8-9ad1ea113db4",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "55d18f13-aa4e-4667-82de-ce09b2930969",
"db_language_id": "ead5361f-6dd2-4f43-97e9-d1592ccf85b1",
"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-12-31T21:40:51.0894002+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4ed0e017-6912-4130-a648-5ab0cf15735b",
"sales_organization": {
"id": "fe818049-a9a0-4a81-8bd8-d23d61e71b5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b40428a5-92a6-4f98-84b4-5a9cc20a9150",
"db_currency_id": "fb3b0d3b-8b8e-4db3-a619-2022bfec9e38",
"db_language_id": "ba5709a7-fa8f-446d-bcd1-b57f98e78c79",
"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-12-31T21:40:51.073799+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "738ed912-9f56-4d6c-8bd7-9fb6debf56bf",
"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": "67dba15f-b9c8-4b5c-865d-255c41704f22",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-31T21:40:51.0894002+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5bd04058-f74e-463e-92e3-cb77d79eb77c"
},
"suggested_date_start": "2025-12-31T21:40:51.0894002+00:00",
"skill_id": "1bf659e2-ba8e-4f26-bfdf-c684ecb59bec",
"skill_code": "sample string 32",
"skill": {
"id": "eb19f3be-12b5-47b4-97ae-feca0d8f15b2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "36177cd7-29fc-4ca2-af61-fd6cf1e4167e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fe818049-a9a0-4a81-8bd8-d23d61e71b5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b40428a5-92a6-4f98-84b4-5a9cc20a9150",
"db_currency_id": "fb3b0d3b-8b8e-4db3-a619-2022bfec9e38",
"db_language_id": "ba5709a7-fa8f-446d-bcd1-b57f98e78c79",
"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-12-31T21:40:51.073799+00:00"
},
"modified_dateutc": "2025-12-31T21:40:51.0894002+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8d162988-35a7-49ee-8d82-8263d0236d10",
"date_reported_by_company": "2025-12-31T21:40:51.0894002+00:00",
"id2": 36,
"company_id": "06d6f3db-4ec0-49c0-9892-599a6b382ded",
"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": "644c0cd5-e458-40f4-b267-52c79fbf014a",
"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-12-31T21:40:51.0894002+00:00"
},
"work_instruction_details_id": "0e288e64-8664-4445-bfbe-eab5add9f945",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0316a827-c724-4898-9115-6d8b6205d073",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "dc3949f2-8fec-4771-a93b-3bb880eb9ff7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-31T21:40:51.0894002+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": "4864aaaf-8870-484f-8421-6e028ecb6293",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-31T21:40:51.0894002+00:00"
}