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": "f03665e4-3e06-4019-863e-043d17d64ea5",
"jobs_id": "5ba8cf37-b4d7-459d-93c2-08e75d7157e1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "33cae64d-2090-466f-8822-0f8edf873afb",
"_parent_id": "510e8a9a-4b33-4ace-8467-24f876deb212",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "11d24661-36c4-44b0-84a6-d22b9fc3e62e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7609fcb4-d12b-4b84-bb31-8dd58120cafc",
"_parent_id": "f39b2253-5f65-4387-a578-73d7303ab870",
"root_parent_id": "8ce345a2-a08c-4492-b744-4f1852cde210",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4aa69ce8-27e2-465c-8700-f4168f003862",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "49f99132-e408-42fb-bca3-c16f485e8518",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "aa548e3d-f3eb-4b8f-8363-f5b3431a28b5",
"_parent_code": "sample string 6",
"sales_organization_id": "10ee9f4a-df79-4795-9b41-90bb97624de6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6179f4a9-b4ea-4ddb-8bf0-741a56af5702",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bec660bd-906c-42ee-80a6-eec8110921f5",
"db_currency_id": "ae0cfa64-5eca-4bd8-bc5b-b385f5bc7d28",
"db_language_id": "ef316016-731b-4d90-9e96-bd5560d97aff",
"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-03-07T12:37:44.6035921+00:00"
},
"modified_dateutc": "2026-03-07T12:37:44.6035921+00:00"
},
"equipment_model_id": "0690a2e7-c0b6-4162-b265-8920c10c8372",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "deb09275-e3b6-47c3-a3e1-0a4541cdf612",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d441fbca-fc41-43bf-bc9f-3c7885ea1b32",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "05daed5c-edd4-4bd1-861f-5b44c2c79e69",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5dfb2082-d883-45ee-a587-4079a0800cf5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6179f4a9-b4ea-4ddb-8bf0-741a56af5702",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bec660bd-906c-42ee-80a6-eec8110921f5",
"db_currency_id": "ae0cfa64-5eca-4bd8-bc5b-b385f5bc7d28",
"db_language_id": "ef316016-731b-4d90-9e96-bd5560d97aff",
"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-03-07T12:37:44.6035921+00:00"
},
"modified_dateutc": "2026-03-07T12:37:44.6035921+00:00"
},
"equipment_family_id": "6e2a647f-44e7-4865-b616-2d4fc8d765fe",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "49f99132-e408-42fb-bca3-c16f485e8518",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "aa548e3d-f3eb-4b8f-8363-f5b3431a28b5",
"_parent_code": "sample string 6",
"sales_organization_id": "10ee9f4a-df79-4795-9b41-90bb97624de6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6179f4a9-b4ea-4ddb-8bf0-741a56af5702",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bec660bd-906c-42ee-80a6-eec8110921f5",
"db_currency_id": "ae0cfa64-5eca-4bd8-bc5b-b385f5bc7d28",
"db_language_id": "ef316016-731b-4d90-9e96-bd5560d97aff",
"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-03-07T12:37:44.6035921+00:00"
},
"modified_dateutc": "2026-03-07T12:37:44.6035921+00:00"
},
"date_in_production_since": "2026-03-07T12:37:44.6035921+00:00",
"date_out_of_production_since": "2026-03-07T12:37:44.6035921+00:00",
"date_end_support": "2026-03-07T12:37:44.6035921+00:00",
"sales_organization_id": "4b3902a8-b571-4ab4-8b8e-926bb306ab62",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6179f4a9-b4ea-4ddb-8bf0-741a56af5702",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bec660bd-906c-42ee-80a6-eec8110921f5",
"db_currency_id": "ae0cfa64-5eca-4bd8-bc5b-b385f5bc7d28",
"db_language_id": "ef316016-731b-4d90-9e96-bd5560d97aff",
"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-03-07T12:37:44.6035921+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-03-07T12:37:44.6192197+00:00"
},
"project_status_id": "84a635fe-664c-4f21-982f-9da1efca2f6d",
"project_status_code": "sample string 10",
"project_status": {
"id": "ad9f41bd-1cad-44ef-aea0-30f0ac18a4d2",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fc24c323-27b7-4638-9cf7-0e4ca16a2180",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6179f4a9-b4ea-4ddb-8bf0-741a56af5702",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bec660bd-906c-42ee-80a6-eec8110921f5",
"db_currency_id": "ae0cfa64-5eca-4bd8-bc5b-b385f5bc7d28",
"db_language_id": "ef316016-731b-4d90-9e96-bd5560d97aff",
"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-03-07T12:37:44.6035921+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-07T12:37:44.6192197+00:00"
},
"company_id": "85327be3-8c2f-4808-ab85-a51961975dc4",
"company_code": "sample string 12",
"db_address_id": "1a4bb9cf-810d-484d-a16a-48c73008f7b2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c89a911d-118e-40bb-9c1b-8adc9c0466dd",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a81d7ebc-c1d8-4511-a7f5-7195df1123b3",
"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-03-07T12:37:44.6192197+00:00",
"date_create": "2026-03-07T12:37:44.6192197+00:00",
"date_update": "2026-03-07T12:37:44.6192197+00:00",
"updated_by_user_id": "156c473d-c0e1-4035-ae4d-29202c640295",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-07T12:37:44.6192197+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-03-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-07T12:37:44.6192197+00:00",
"date_last_job": "2026-03-07T12:37:44.6192197+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-07T12:37:44.6192197+00:00",
"modified_dateutc": "2026-03-07T12:37:44.6192197+00:00",
"is_mobile_installation": true
},
"job_type_id": "54e31d77-d14d-4cbd-8ac2-4b639c3a0ebc",
"job_type_code": "sample string 7",
"job_type": {
"id": "3d67c8b5-5ada-41ae-86ed-6bbc26fc7466",
"name": "sample string 2",
"sales_organization_id": "06755ef5-8c8a-42a7-a6ba-99aeb8bef62b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-07T12:37:44.6192197+00:00",
"code": "sample string 7"
},
"job_priority_id": "eb9e76ca-8e41-4ba4-a1e2-ef3f7cc25f5d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e7dcfc7b-99b5-412c-a84d-e23d67722d34",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2509d947-d994-4f71-9bfa-d346f2f07b41",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6179f4a9-b4ea-4ddb-8bf0-741a56af5702",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bec660bd-906c-42ee-80a6-eec8110921f5",
"db_currency_id": "ae0cfa64-5eca-4bd8-bc5b-b385f5bc7d28",
"db_language_id": "ef316016-731b-4d90-9e96-bd5560d97aff",
"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-03-07T12:37:44.6035921+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-07T12:37:44.6192197+00:00"
},
"job_status_id": "d4cb6142-f163-4b19-8dbc-2845073dfc58",
"job_status_code": "sample string 11",
"db_address_id": "6e184af3-a0f9-4ef4-9cbb-f2d0d8a57586",
"contact_id": "f10e65d6-bd92-47ca-8b38-2062f408d14a",
"requested_by_company_id": "6c55be70-0b2a-485d-8c0c-646e664f0a04",
"requested_by_contact_id": "ff1449c2-30a9-4575-8ea0-c764e270c7a8",
"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-03-07T12:37:44.6192197+00:00",
"due_date": "2026-03-07T12:37:44.6192197+00:00",
"date_create": "2026-03-07T12:37:44.6192197+00:00",
"date_update": "2026-03-07T12:37:44.6192197+00:00",
"date_closed": "2026-03-07T12:37:44.6192197+00:00",
"suggested_user_id": "3fbe3eee-2f1b-4511-85d9-1ed79c97d467",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8eed25c0-7e9e-457a-b608-7193463e3f39",
"db_language_id": "346d89b7-38e1-405b-b239-f9ea8a3fb463",
"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-03-07T12:37:44.6192197+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c5dcb539-aa17-46d5-9d6a-476d875331bd",
"sales_organization": {
"id": "6179f4a9-b4ea-4ddb-8bf0-741a56af5702",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bec660bd-906c-42ee-80a6-eec8110921f5",
"db_currency_id": "ae0cfa64-5eca-4bd8-bc5b-b385f5bc7d28",
"db_language_id": "ef316016-731b-4d90-9e96-bd5560d97aff",
"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-03-07T12:37:44.6035921+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7f5643e2-4ace-4b0c-930c-55d8297b03f6",
"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": "7f616532-610b-4244-818f-1f3502857ec3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-07T12:37:44.6192197+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "790134be-d39b-460b-8e25-b799e51a751c"
},
"suggested_date_start": "2026-03-07T12:37:44.6192197+00:00",
"skill_id": "b51bb427-9ecb-443f-9976-fd23b2da95f8",
"skill_code": "sample string 32",
"skill": {
"id": "90f7e155-46ce-4030-9ac1-dde72ac6020c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "08896605-91ba-475e-ae5e-3a7e188e8f61",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6179f4a9-b4ea-4ddb-8bf0-741a56af5702",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bec660bd-906c-42ee-80a6-eec8110921f5",
"db_currency_id": "ae0cfa64-5eca-4bd8-bc5b-b385f5bc7d28",
"db_language_id": "ef316016-731b-4d90-9e96-bd5560d97aff",
"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-03-07T12:37:44.6035921+00:00"
},
"modified_dateutc": "2026-03-07T12:37:44.6192197+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "78fbf03b-09e8-4b26-857d-88e5ca8c681b",
"date_reported_by_company": "2026-03-07T12:37:44.6192197+00:00",
"id2": 36,
"company_id": "ec2a4999-1c36-4904-a789-b100f3892f7d",
"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": "c2188321-a174-4d10-a495-44f9af106523",
"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-03-07T12:37:44.6192197+00:00"
},
"work_instruction_details_id": "a689d456-30b9-43c2-9ff3-d08dcb31b9ba",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3df3fcca-3b89-4017-acff-54da9e7ff0bb",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cf17f035-fa60-42ff-82dc-81fbd6410be4",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-07T12:37:44.6192197+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": "603af9de-0490-42a4-a942-6a3f6cc51b15",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-07T12:37:44.6192197+00:00"
}