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": "3cae5af4-f3ed-4715-9f05-44a0b8040085",
"jobs_id": "81939165-9db2-424c-a42d-7a37ac9f65cd",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "70e4ea65-f156-46df-bf54-3db1b26e21f8",
"_parent_id": "26b4273d-d585-453d-8d0a-18d0b2077ae9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "10bf6aa9-e260-4d4b-8053-cbcfbf365678",
"project_reference_back_office": "sample string 5",
"project": {
"id": "09c04302-0e04-49b4-9fe5-6a8053b4ec1a",
"_parent_id": "022783f0-f576-465b-863a-68fba68d023f",
"root_parent_id": "96b09803-cf7a-4dce-9f79-e1e872d3d16f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "91b9137e-f218-4baa-bac1-bccd87245cfd",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "71cd04fb-a6f6-40a3-88ad-09252a60cc31",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1f639354-511f-46e7-aaae-7505b8a1449b",
"_parent_code": "sample string 6",
"sales_organization_id": "284bdd11-0264-4ca5-8bd8-cb7357467010",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3910138b-5c65-407c-87f5-3506bc67839f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7b929e5-3259-4047-ac85-6e1d57ee82a1",
"db_currency_id": "89d1f8dc-bc05-4eb9-9a34-5d5672c9f5cb",
"db_language_id": "38d69462-f1dc-4444-9a04-f1bf2d3683f6",
"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-09-02T16:30:43.5378407+00:00"
},
"modified_dateutc": "2026-09-02T16:30:43.5378407+00:00"
},
"equipment_model_id": "0d3cea92-6257-47cd-b3ff-9a073392645a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6f9f4b07-11a9-49df-9652-f0865f25dbf4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b3c8f65b-cd56-497e-bf4b-fd4b95cdd366",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e397acda-1460-42db-b47f-09cd274e2d43",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "bbb74d0c-5e61-4ee4-ae60-f52484a8f439",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3910138b-5c65-407c-87f5-3506bc67839f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7b929e5-3259-4047-ac85-6e1d57ee82a1",
"db_currency_id": "89d1f8dc-bc05-4eb9-9a34-5d5672c9f5cb",
"db_language_id": "38d69462-f1dc-4444-9a04-f1bf2d3683f6",
"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-09-02T16:30:43.5378407+00:00"
},
"modified_dateutc": "2026-09-02T16:30:43.5378407+00:00"
},
"equipment_family_id": "2e1cea44-4383-4204-802f-400a593c3dac",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "71cd04fb-a6f6-40a3-88ad-09252a60cc31",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1f639354-511f-46e7-aaae-7505b8a1449b",
"_parent_code": "sample string 6",
"sales_organization_id": "284bdd11-0264-4ca5-8bd8-cb7357467010",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3910138b-5c65-407c-87f5-3506bc67839f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7b929e5-3259-4047-ac85-6e1d57ee82a1",
"db_currency_id": "89d1f8dc-bc05-4eb9-9a34-5d5672c9f5cb",
"db_language_id": "38d69462-f1dc-4444-9a04-f1bf2d3683f6",
"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-09-02T16:30:43.5378407+00:00"
},
"modified_dateutc": "2026-09-02T16:30:43.5378407+00:00"
},
"date_in_production_since": "2026-09-02T16:30:43.5378407+00:00",
"date_out_of_production_since": "2026-09-02T16:30:43.5378407+00:00",
"date_end_support": "2026-09-02T16:30:43.5378407+00:00",
"sales_organization_id": "21d19b06-420f-4bbc-a168-e44eaf0a6c43",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3910138b-5c65-407c-87f5-3506bc67839f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7b929e5-3259-4047-ac85-6e1d57ee82a1",
"db_currency_id": "89d1f8dc-bc05-4eb9-9a34-5d5672c9f5cb",
"db_language_id": "38d69462-f1dc-4444-9a04-f1bf2d3683f6",
"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-09-02T16:30:43.5378407+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-09-02T16:30:43.5378407+00:00"
},
"project_status_id": "789e5557-a0eb-4e6f-9a10-052c9c921bd2",
"project_status_code": "sample string 10",
"project_status": {
"id": "7d353e9f-0090-4043-b47b-cbb2cde58818",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "83d7b4f3-5b6b-4f81-a731-8c682ca90045",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3910138b-5c65-407c-87f5-3506bc67839f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7b929e5-3259-4047-ac85-6e1d57ee82a1",
"db_currency_id": "89d1f8dc-bc05-4eb9-9a34-5d5672c9f5cb",
"db_language_id": "38d69462-f1dc-4444-9a04-f1bf2d3683f6",
"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-09-02T16:30:43.5378407+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-02T16:30:43.5378407+00:00"
},
"company_id": "021fac85-d23e-495a-b510-eb713a136aaa",
"company_code": "sample string 12",
"db_address_id": "3cccd075-da41-4395-91c2-edd94b692962",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "18ce991e-268b-4063-9ecc-a524d1d07e97",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3c60338e-3505-457e-8151-3a6caf471fb6",
"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-09-02T16:30:43.5378407+00:00",
"date_create": "2026-09-02T16:30:43.5378407+00:00",
"date_update": "2026-09-02T16:30:43.5378407+00:00",
"updated_by_user_id": "9d483151-38f1-4b80-8199-36bf6aa6a07b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-02T16:30:43.5378407+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-09-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-02T16:30:43.5378407+00:00",
"date_last_job": "2026-09-02T16:30:43.5378407+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-02T16:30:43.5378407+00:00",
"modified_dateutc": "2026-09-02T16:30:43.5378407+00:00",
"is_mobile_installation": true
},
"job_type_id": "a6a8a989-84a2-44be-9b01-0741821db520",
"job_type_code": "sample string 7",
"job_type": {
"id": "d3ce8d4c-97d9-477b-9284-837acfe058c8",
"name": "sample string 2",
"sales_organization_id": "f99b47cd-6570-417f-9e14-3d09c251269b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-02T16:30:43.5378407+00:00",
"code": "sample string 7"
},
"job_priority_id": "638e3844-fd27-4cd4-82a4-c7dea5593e5b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e12bcd37-0a69-42b6-aa73-81e165abb017",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2a2ccdb4-a04d-4c15-b10f-b15aa9b87853",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3910138b-5c65-407c-87f5-3506bc67839f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7b929e5-3259-4047-ac85-6e1d57ee82a1",
"db_currency_id": "89d1f8dc-bc05-4eb9-9a34-5d5672c9f5cb",
"db_language_id": "38d69462-f1dc-4444-9a04-f1bf2d3683f6",
"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-09-02T16:30:43.5378407+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-02T16:30:43.5378407+00:00"
},
"job_status_id": "6f68bf71-cd15-4cfa-b63e-3c66f9604758",
"job_status_code": "sample string 11",
"db_address_id": "b7ef80f2-e0f7-4629-b101-f690a7d5403b",
"contact_id": "7bb019f3-c3c6-402c-95f4-4605c25edd47",
"requested_by_company_id": "85682498-5ca2-4ccf-a0fe-6cac021281b2",
"requested_by_contact_id": "8c050ecb-69ba-4379-bfc8-28785bc3adf5",
"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-09-02T16:30:43.5378407+00:00",
"due_date": "2026-09-02T16:30:43.5378407+00:00",
"date_create": "2026-09-02T16:30:43.5378407+00:00",
"date_update": "2026-09-02T16:30:43.5378407+00:00",
"date_closed": "2026-09-02T16:30:43.5378407+00:00",
"suggested_user_id": "c72bd828-76fc-41f4-9d41-ebb08c628c2f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ef927e83-0d0b-4afd-a67d-b669bd8037a1",
"db_language_id": "0bf6dd47-c0da-48c1-a415-2903c7e3e0ca",
"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-09-02T16:30:43.5378407+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "550bb6a2-455b-471c-9c3a-41545b82b0cd",
"sales_organization": {
"id": "3910138b-5c65-407c-87f5-3506bc67839f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7b929e5-3259-4047-ac85-6e1d57ee82a1",
"db_currency_id": "89d1f8dc-bc05-4eb9-9a34-5d5672c9f5cb",
"db_language_id": "38d69462-f1dc-4444-9a04-f1bf2d3683f6",
"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-09-02T16:30:43.5378407+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "141f056c-4b4d-4c8a-82cf-8831b04ad705",
"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": "f2347ad2-7bec-469c-bf58-0c62f0b171c7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-02T16:30:43.5378407+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d7f45cfc-5cba-4ead-8f2a-4120438ad9de"
},
"suggested_date_start": "2026-09-02T16:30:43.5378407+00:00",
"skill_id": "2c835ab8-998b-43a3-8b93-af9f1af8d067",
"skill_code": "sample string 32",
"skill": {
"id": "b4482505-1a87-4327-a476-5bfbc857bdc3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "99f8ac62-7da4-4a14-8351-15bb1516ae3f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3910138b-5c65-407c-87f5-3506bc67839f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7b929e5-3259-4047-ac85-6e1d57ee82a1",
"db_currency_id": "89d1f8dc-bc05-4eb9-9a34-5d5672c9f5cb",
"db_language_id": "38d69462-f1dc-4444-9a04-f1bf2d3683f6",
"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-09-02T16:30:43.5378407+00:00"
},
"modified_dateutc": "2026-09-02T16:30:43.5378407+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a84287d9-465a-4f43-8cae-552ec391e3d9",
"date_reported_by_company": "2026-09-02T16:30:43.5378407+00:00",
"id2": 36,
"company_id": "b3ec47ed-4806-4d54-9874-e21231af5f2c",
"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": "ce29ed7e-0101-4bba-8718-7adad5b46de6",
"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-09-02T16:30:43.5378407+00:00"
},
"work_instruction_details_id": "4c321dae-d1c9-4ea8-94bf-06d1e25bc204",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9214fdb1-f2f6-4669-adba-93970b0eade2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d7730787-0fb8-4bcf-94ef-3161b55dbe8e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-02T16:30:43.5378407+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": "8f622d9b-afe2-40df-a858-896b674520dd",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-02T16:30:43.5378407+00:00"
}