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": "4faad6e0-2e5e-4090-97d4-d25379f2080d",
"jobs_id": "c9d4be1e-00c6-4793-bf74-40832506ffaf",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f838ca35-be8f-48ea-8a9c-8971fa6cbbbe",
"_parent_id": "adaede05-c0ac-4c75-9a36-8e828e40cf13",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a4b870b3-0fc8-447c-bca9-c6cc6772084c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5d7e3004-596f-4238-a0ee-eed96b4468b8",
"_parent_id": "42d710ed-5316-41e3-8df0-01794a8bde4c",
"root_parent_id": "587e0009-1e9f-49a8-b768-f9c84377bf9d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e0986614-bfd5-4e08-af48-71ef49336349",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "769f6579-2fa4-4f13-978c-694b234284ff",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "32cec313-274a-4d89-8f6e-f43a06c26977",
"_parent_code": "sample string 6",
"sales_organization_id": "4ecc6f5e-72d9-4fa4-bb05-87601ce7b217",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1d6bd858-ce23-4283-acd0-f56f207c869b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f22d981-2107-4d69-b8c5-fd3705e1b538",
"db_currency_id": "f930e797-bc71-4830-a357-25cceae03a81",
"db_language_id": "22c63849-3a58-4629-9fb0-02aaaccc947d",
"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-11-28T02:02:48.7047912+00:00"
},
"modified_dateutc": "2025-11-28T02:02:48.7047912+00:00"
},
"equipment_model_id": "c7d47d42-e368-49c3-a468-20e50153571f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9cc9166a-84e5-4c2b-9026-1529effe8ef3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d06b303c-bfd8-404b-af58-e75f740d35d3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "26da3445-279a-491b-8677-7ec5640339f8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d9102505-d829-4f96-8c87-ded437bfef82",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1d6bd858-ce23-4283-acd0-f56f207c869b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f22d981-2107-4d69-b8c5-fd3705e1b538",
"db_currency_id": "f930e797-bc71-4830-a357-25cceae03a81",
"db_language_id": "22c63849-3a58-4629-9fb0-02aaaccc947d",
"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-11-28T02:02:48.7047912+00:00"
},
"modified_dateutc": "2025-11-28T02:02:48.7047912+00:00"
},
"equipment_family_id": "98cebb4e-fe57-49f9-b875-dd7ebe209d79",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "769f6579-2fa4-4f13-978c-694b234284ff",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "32cec313-274a-4d89-8f6e-f43a06c26977",
"_parent_code": "sample string 6",
"sales_organization_id": "4ecc6f5e-72d9-4fa4-bb05-87601ce7b217",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1d6bd858-ce23-4283-acd0-f56f207c869b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f22d981-2107-4d69-b8c5-fd3705e1b538",
"db_currency_id": "f930e797-bc71-4830-a357-25cceae03a81",
"db_language_id": "22c63849-3a58-4629-9fb0-02aaaccc947d",
"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-11-28T02:02:48.7047912+00:00"
},
"modified_dateutc": "2025-11-28T02:02:48.7047912+00:00"
},
"date_in_production_since": "2025-11-28T02:02:48.7047912+00:00",
"date_out_of_production_since": "2025-11-28T02:02:48.7047912+00:00",
"date_end_support": "2025-11-28T02:02:48.7047912+00:00",
"sales_organization_id": "62204e31-c0f8-4265-a20c-e33e77ef83f4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1d6bd858-ce23-4283-acd0-f56f207c869b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f22d981-2107-4d69-b8c5-fd3705e1b538",
"db_currency_id": "f930e797-bc71-4830-a357-25cceae03a81",
"db_language_id": "22c63849-3a58-4629-9fb0-02aaaccc947d",
"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-11-28T02:02:48.7047912+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-11-28T02:02:48.7047912+00:00"
},
"project_status_id": "428c8236-8b5e-48f9-bcc8-b8493bfc1b9a",
"project_status_code": "sample string 10",
"project_status": {
"id": "64c5e195-69da-4b53-a051-07a8c2f8f8b4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0145046e-81f6-4eb5-91a2-d8bbc685136d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1d6bd858-ce23-4283-acd0-f56f207c869b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f22d981-2107-4d69-b8c5-fd3705e1b538",
"db_currency_id": "f930e797-bc71-4830-a357-25cceae03a81",
"db_language_id": "22c63849-3a58-4629-9fb0-02aaaccc947d",
"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-11-28T02:02:48.7047912+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-28T02:02:48.7047912+00:00"
},
"company_id": "ee95ec88-c9d5-496a-9a02-1b46dccbea2a",
"company_code": "sample string 12",
"db_address_id": "9685acf3-4a85-4819-97b9-94ea417bb309",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "aa50a76d-d64d-43a3-aa21-212a28740a31",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "abd68e24-2cd0-4f5a-b89d-edc91aa4b767",
"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-11-28T02:02:48.7047912+00:00",
"date_create": "2025-11-28T02:02:48.7047912+00:00",
"date_update": "2025-11-28T02:02:48.7047912+00:00",
"updated_by_user_id": "2a582418-6570-4b84-a645-bdf3427acbaf",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-28T02:02:48.7047912+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-11-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-28T02:02:48.7204107+00:00",
"date_last_job": "2025-11-28T02:02:48.7204107+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-28T02:02:48.7204107+00:00",
"modified_dateutc": "2025-11-28T02:02:48.7204107+00:00",
"is_mobile_installation": true
},
"job_type_id": "9e23d658-1074-46c4-b168-f969f82cb5e0",
"job_type_code": "sample string 7",
"job_type": {
"id": "e8f47856-5735-429c-aecf-e11b47320b4a",
"name": "sample string 2",
"sales_organization_id": "8d7330dd-51be-4a12-8bf1-331faeac2656",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-28T02:02:48.7204107+00:00",
"code": "sample string 7"
},
"job_priority_id": "a6801471-8906-43f2-979f-883264d1155b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "24e49d26-1c28-43e3-8be4-21fb297e8462",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "cad85c7e-777e-4c83-afe8-63adfbc1a634",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1d6bd858-ce23-4283-acd0-f56f207c869b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f22d981-2107-4d69-b8c5-fd3705e1b538",
"db_currency_id": "f930e797-bc71-4830-a357-25cceae03a81",
"db_language_id": "22c63849-3a58-4629-9fb0-02aaaccc947d",
"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-11-28T02:02:48.7047912+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-28T02:02:48.7204107+00:00"
},
"job_status_id": "6dce3498-e873-4be1-8521-652a9f6d7230",
"job_status_code": "sample string 11",
"db_address_id": "7fec066c-aa6a-442c-a857-f9994b3637e2",
"contact_id": "6aca5bec-be88-454e-bc22-e2126343245d",
"requested_by_company_id": "8479422d-5f9e-4213-b3a6-f4a688c4a9e3",
"requested_by_contact_id": "1aa6a768-b506-4966-aee6-922226461b79",
"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-11-28T02:02:48.7204107+00:00",
"due_date": "2025-11-28T02:02:48.7204107+00:00",
"date_create": "2025-11-28T02:02:48.7204107+00:00",
"date_update": "2025-11-28T02:02:48.7204107+00:00",
"date_closed": "2025-11-28T02:02:48.7204107+00:00",
"suggested_user_id": "b764795f-7e00-4281-8d24-a6a82fef3923",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "716219d5-5eea-40b6-96c2-7b199f67adc5",
"db_language_id": "03b42f76-ecdf-42ef-a339-26674fd31eec",
"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-11-28T02:02:48.7204107+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "244d779a-bfd7-4bd9-8b34-04ea4e973f0c",
"sales_organization": {
"id": "1d6bd858-ce23-4283-acd0-f56f207c869b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f22d981-2107-4d69-b8c5-fd3705e1b538",
"db_currency_id": "f930e797-bc71-4830-a357-25cceae03a81",
"db_language_id": "22c63849-3a58-4629-9fb0-02aaaccc947d",
"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-11-28T02:02:48.7047912+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5bd1bab7-4fff-4bbf-a077-8d1dbe942490",
"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": "9d627e0e-de15-4f25-9c8e-83997d74c8bc",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-28T02:02:48.7204107+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "51b3350e-bafd-4503-8711-0d198f18026b"
},
"suggested_date_start": "2025-11-28T02:02:48.7204107+00:00",
"skill_id": "83d867a3-ef6b-449c-aa10-7b0e0b6e0467",
"skill_code": "sample string 32",
"skill": {
"id": "64f6c254-5efa-46a5-81b1-79abaa4e72c5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ce6849a2-c5d2-4c3b-9978-9f4ded84b39a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1d6bd858-ce23-4283-acd0-f56f207c869b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f22d981-2107-4d69-b8c5-fd3705e1b538",
"db_currency_id": "f930e797-bc71-4830-a357-25cceae03a81",
"db_language_id": "22c63849-3a58-4629-9fb0-02aaaccc947d",
"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-11-28T02:02:48.7047912+00:00"
},
"modified_dateutc": "2025-11-28T02:02:48.7204107+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "64c24e33-468e-4ad5-99a7-31f3750899fb",
"date_reported_by_company": "2025-11-28T02:02:48.7204107+00:00",
"id2": 36,
"company_id": "455daa9a-a822-4f33-98e9-aa391bf3a6bf",
"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": "9cd5c354-a0a9-4302-bdef-f69f83b1a7d2",
"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-11-28T02:02:48.7204107+00:00"
},
"work_instruction_details_id": "1f635ae3-9213-445b-8630-41223723f574",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ba17a127-f5a0-4c20-b07b-0cf3d9133311",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d263679a-02e1-43a5-88e3-eb21add6ae20",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-28T02:02:48.7204107+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": "dc9e0d18-8bc9-4238-a627-a56565792a2e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-28T02:02:48.7204107+00:00"
}