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": "e413b01f-a376-4a12-962d-ec2e1d835839",
"jobs_id": "c6348105-516b-4467-8803-40d94e67e71d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "58c165db-7d04-407e-8b19-871770fb30cb",
"_parent_id": "06cc2e81-9697-4e35-a6a3-e47d365ff5d9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "75a931b5-c280-4a8b-92dd-1304def286e6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1ffe1df5-3b15-4df6-9ecb-9ec257b36bf7",
"_parent_id": "02ab19e1-d290-4516-9a0d-b0017b34e6d5",
"root_parent_id": "e5465b4f-e9db-4109-9cdd-18aab37fad97",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "62156941-deee-48e2-b177-095a0dd560a0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "bef04613-5fae-491b-bb5c-5edbf0f9f3c7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "408b4198-4f78-455c-b376-57ff67c68205",
"_parent_code": "sample string 6",
"sales_organization_id": "282b9f58-a612-478e-ba55-aa023968fd43",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c8da8c75-48d1-427b-9b3d-02b8e892eb6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e57782df-4400-44c5-8816-0b310104a61a",
"db_currency_id": "988a59c0-3e7c-4afa-8e08-b5d3d436ef2d",
"db_language_id": "5f1af8a6-451b-4f99-aa4c-3f8df4401196",
"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-05T02:47:09.808496+00:00"
},
"modified_dateutc": "2025-12-05T02:47:09.808496+00:00"
},
"equipment_model_id": "02f1634d-51c9-43f1-9603-57c5fa8ea8cb",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0b4e7670-16d0-419b-8761-9a0888b549ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0d2955b7-01be-4f84-8ade-b8ddd20c92b3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "35904fc1-59b8-4a1d-be59-69bbb9dfe8d9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9b79eea8-24da-4387-9268-a47af82a1a30",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c8da8c75-48d1-427b-9b3d-02b8e892eb6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e57782df-4400-44c5-8816-0b310104a61a",
"db_currency_id": "988a59c0-3e7c-4afa-8e08-b5d3d436ef2d",
"db_language_id": "5f1af8a6-451b-4f99-aa4c-3f8df4401196",
"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-05T02:47:09.808496+00:00"
},
"modified_dateutc": "2025-12-05T02:47:09.808496+00:00"
},
"equipment_family_id": "209de27e-4a6e-4d36-a72e-55adcd33d880",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "bef04613-5fae-491b-bb5c-5edbf0f9f3c7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "408b4198-4f78-455c-b376-57ff67c68205",
"_parent_code": "sample string 6",
"sales_organization_id": "282b9f58-a612-478e-ba55-aa023968fd43",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c8da8c75-48d1-427b-9b3d-02b8e892eb6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e57782df-4400-44c5-8816-0b310104a61a",
"db_currency_id": "988a59c0-3e7c-4afa-8e08-b5d3d436ef2d",
"db_language_id": "5f1af8a6-451b-4f99-aa4c-3f8df4401196",
"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-05T02:47:09.808496+00:00"
},
"modified_dateutc": "2025-12-05T02:47:09.808496+00:00"
},
"date_in_production_since": "2025-12-05T02:47:09.808496+00:00",
"date_out_of_production_since": "2025-12-05T02:47:09.808496+00:00",
"date_end_support": "2025-12-05T02:47:09.808496+00:00",
"sales_organization_id": "cd5a1b69-2f12-4569-9e02-9e6eda77f1d7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c8da8c75-48d1-427b-9b3d-02b8e892eb6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e57782df-4400-44c5-8816-0b310104a61a",
"db_currency_id": "988a59c0-3e7c-4afa-8e08-b5d3d436ef2d",
"db_language_id": "5f1af8a6-451b-4f99-aa4c-3f8df4401196",
"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-05T02:47:09.808496+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-05T02:47:09.808496+00:00"
},
"project_status_id": "1cd0d829-c190-48d6-bcd2-6e949f2ded27",
"project_status_code": "sample string 10",
"project_status": {
"id": "9c1d4231-c17c-4295-a5b7-a50edabc20ec",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fc30f9f4-cc32-4729-8e94-04259aee3879",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c8da8c75-48d1-427b-9b3d-02b8e892eb6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e57782df-4400-44c5-8816-0b310104a61a",
"db_currency_id": "988a59c0-3e7c-4afa-8e08-b5d3d436ef2d",
"db_language_id": "5f1af8a6-451b-4f99-aa4c-3f8df4401196",
"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-05T02:47:09.808496+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-05T02:47:09.808496+00:00"
},
"company_id": "ccea626d-bb77-4c28-b5d8-3c6286e25e55",
"company_code": "sample string 12",
"db_address_id": "4a169354-3897-476c-b4e8-838ad03f0ab6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c455e072-ad54-4aea-98c5-99a7e41eb34f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d8c67a44-fdc4-461b-b111-088c46027509",
"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-05T02:47:09.808496+00:00",
"date_create": "2025-12-05T02:47:09.808496+00:00",
"date_update": "2025-12-05T02:47:09.808496+00:00",
"updated_by_user_id": "18e6b0ad-98e2-4a96-83cf-8053ec3707c6",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-05T02:47:09.808496+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-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-05T02:47:09.808496+00:00",
"date_last_job": "2025-12-05T02:47:09.808496+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-05T02:47:09.808496+00:00",
"modified_dateutc": "2025-12-05T02:47:09.808496+00:00",
"is_mobile_installation": true
},
"job_type_id": "984b7d4d-7477-4d48-adcf-565c53a919df",
"job_type_code": "sample string 7",
"job_type": {
"id": "629fbe33-0718-472a-9ba9-fc1401649499",
"name": "sample string 2",
"sales_organization_id": "67d7994e-9bce-4c10-b1d2-07c971d4f39a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-05T02:47:09.808496+00:00",
"code": "sample string 7"
},
"job_priority_id": "2d185ccb-61b9-4b85-9e2e-4a04e80309f3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3c11c90f-4023-4ed3-8498-0e2bed6de1bb",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1da8dd8d-8aed-4981-852f-d783b117c752",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c8da8c75-48d1-427b-9b3d-02b8e892eb6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e57782df-4400-44c5-8816-0b310104a61a",
"db_currency_id": "988a59c0-3e7c-4afa-8e08-b5d3d436ef2d",
"db_language_id": "5f1af8a6-451b-4f99-aa4c-3f8df4401196",
"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-05T02:47:09.808496+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-05T02:47:09.808496+00:00"
},
"job_status_id": "7050d46f-b8b3-42ba-acd6-fa6af708b710",
"job_status_code": "sample string 11",
"db_address_id": "c382f8b3-940e-46ca-b1f1-a19ff9ed7a7f",
"contact_id": "91b3220b-df0d-4766-9eec-a0a6b204c3d0",
"requested_by_company_id": "af6d4ca1-cdec-47f0-a8aa-d18ff88883b7",
"requested_by_contact_id": "29eb5e89-5736-4075-bab3-90aeb1dfb092",
"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-05T02:47:09.808496+00:00",
"due_date": "2025-12-05T02:47:09.808496+00:00",
"date_create": "2025-12-05T02:47:09.808496+00:00",
"date_update": "2025-12-05T02:47:09.808496+00:00",
"date_closed": "2025-12-05T02:47:09.808496+00:00",
"suggested_user_id": "661159a7-e287-4062-8bc3-1685eec36c1b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "19c63324-e72b-4143-8d33-35cdbdebc035",
"db_language_id": "1b518c03-f92b-417a-bc5c-9855c17492c7",
"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-05T02:47:09.808496+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "578fe6d6-80d5-4ba1-bd58-94029e2c96bb",
"sales_organization": {
"id": "c8da8c75-48d1-427b-9b3d-02b8e892eb6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e57782df-4400-44c5-8816-0b310104a61a",
"db_currency_id": "988a59c0-3e7c-4afa-8e08-b5d3d436ef2d",
"db_language_id": "5f1af8a6-451b-4f99-aa4c-3f8df4401196",
"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-05T02:47:09.808496+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "185d8918-ba9d-4912-b66d-f610f7601c8b",
"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": "b6648d39-6b06-4cf5-9e63-eabff76eba98",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-05T02:47:09.808496+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "10063b32-f915-4375-85f6-b6693b9d3d55"
},
"suggested_date_start": "2025-12-05T02:47:09.808496+00:00",
"skill_id": "e6f656ba-fa6f-43b2-97c8-408016947d74",
"skill_code": "sample string 32",
"skill": {
"id": "3eafe528-e663-4a9f-8eb2-d4cf4d1aca4f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9cc45e24-0c0f-40b5-b112-3722a2e77cee",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c8da8c75-48d1-427b-9b3d-02b8e892eb6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e57782df-4400-44c5-8816-0b310104a61a",
"db_currency_id": "988a59c0-3e7c-4afa-8e08-b5d3d436ef2d",
"db_language_id": "5f1af8a6-451b-4f99-aa4c-3f8df4401196",
"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-05T02:47:09.808496+00:00"
},
"modified_dateutc": "2025-12-05T02:47:09.808496+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5effa90a-3de0-4a86-aeb1-ce4d130a9722",
"date_reported_by_company": "2025-12-05T02:47:09.808496+00:00",
"id2": 36,
"company_id": "28b10ee3-4180-4da6-9f8d-47f57dafa979",
"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": "e31c9eac-93f3-4299-ba7e-871cd9c5d2fd",
"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-05T02:47:09.808496+00:00"
},
"work_instruction_details_id": "cfe7b05b-5983-4310-8c32-697420d70367",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c9732006-b016-4d2e-8131-c46875f59ea9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cda54b2e-660d-449e-9035-337dda29cce8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-05T02:47:09.808496+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": "a89dcb39-5279-498f-9929-6cf7bfc8a459",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-05T02:47:09.808496+00:00"
}