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": "3dfe30ca-7eb1-4697-b1f5-459ad9644232",
"jobs_id": "aafff423-a8d1-4654-936b-f9b41baaffc8",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b97a7ea5-b93b-45cd-9133-6be5b61bd8f2",
"_parent_id": "9ddef5fc-a16f-404f-9691-893c395ff4a7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6228e2d9-7791-4041-b1c8-8483b6b85075",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e44a1cc2-290c-4f83-ab58-82ce6a52c4d0",
"_parent_id": "e8195d3b-ae76-44f5-9ca2-8566cab408c0",
"root_parent_id": "988ac170-3c39-4f1b-8bb3-f461f8ae32ee",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "08c71447-ed90-40e8-9d19-d25b030f80ae",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "09e24b0e-a827-4021-bb7a-d7e507533c6e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a1d8d832-d6c9-4f04-b9d7-b7113ad4cc57",
"_parent_code": "sample string 6",
"sales_organization_id": "5127a164-b695-4aa7-bf4d-940c859d8f1b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9ff0c68d-48b9-4dba-8aff-76260453b67e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b3cf18c-b83e-42f0-8e75-3e880e7ffda6",
"db_currency_id": "643f5faf-ce3a-4d7b-92bf-e6f9393452fd",
"db_language_id": "734ea462-2adb-4b0e-9c54-f6bedac7cd1f",
"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-01-03T11:48:19.5089292+00:00"
},
"modified_dateutc": "2026-01-03T11:48:19.5089292+00:00"
},
"equipment_model_id": "f466a474-1620-4ea9-acdb-6d662fd3d09d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3d86d8ae-a03f-4cf4-a256-6adb6b8b0d13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b52e3983-f37b-4050-9063-869b14c3a828",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f978ed6d-ee89-4470-a8e1-ab55b584dd5b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f62c8f4c-6f56-4c35-a6ca-26037671c2b9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9ff0c68d-48b9-4dba-8aff-76260453b67e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b3cf18c-b83e-42f0-8e75-3e880e7ffda6",
"db_currency_id": "643f5faf-ce3a-4d7b-92bf-e6f9393452fd",
"db_language_id": "734ea462-2adb-4b0e-9c54-f6bedac7cd1f",
"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-01-03T11:48:19.5089292+00:00"
},
"modified_dateutc": "2026-01-03T11:48:19.5089292+00:00"
},
"equipment_family_id": "bada6987-9c94-4deb-a16c-cfb32b50c2ab",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "09e24b0e-a827-4021-bb7a-d7e507533c6e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a1d8d832-d6c9-4f04-b9d7-b7113ad4cc57",
"_parent_code": "sample string 6",
"sales_organization_id": "5127a164-b695-4aa7-bf4d-940c859d8f1b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9ff0c68d-48b9-4dba-8aff-76260453b67e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b3cf18c-b83e-42f0-8e75-3e880e7ffda6",
"db_currency_id": "643f5faf-ce3a-4d7b-92bf-e6f9393452fd",
"db_language_id": "734ea462-2adb-4b0e-9c54-f6bedac7cd1f",
"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-01-03T11:48:19.5089292+00:00"
},
"modified_dateutc": "2026-01-03T11:48:19.5089292+00:00"
},
"date_in_production_since": "2026-01-03T11:48:19.5089292+00:00",
"date_out_of_production_since": "2026-01-03T11:48:19.5089292+00:00",
"date_end_support": "2026-01-03T11:48:19.5089292+00:00",
"sales_organization_id": "870caaf0-ac88-45e0-8e70-78c2193ab81a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9ff0c68d-48b9-4dba-8aff-76260453b67e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b3cf18c-b83e-42f0-8e75-3e880e7ffda6",
"db_currency_id": "643f5faf-ce3a-4d7b-92bf-e6f9393452fd",
"db_language_id": "734ea462-2adb-4b0e-9c54-f6bedac7cd1f",
"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-01-03T11:48:19.5089292+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-01-03T11:48:19.5089292+00:00"
},
"project_status_id": "219594b6-f617-48f8-8b4c-cc8ab22cd09d",
"project_status_code": "sample string 10",
"project_status": {
"id": "6d5fa32c-bc82-43a5-a248-22a46002edf7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a21677e6-c24b-44d1-bd38-c1a8a5dd1871",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9ff0c68d-48b9-4dba-8aff-76260453b67e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b3cf18c-b83e-42f0-8e75-3e880e7ffda6",
"db_currency_id": "643f5faf-ce3a-4d7b-92bf-e6f9393452fd",
"db_language_id": "734ea462-2adb-4b0e-9c54-f6bedac7cd1f",
"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-01-03T11:48:19.5089292+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-03T11:48:19.5089292+00:00"
},
"company_id": "c3b8ec54-c3a2-4b2f-aa85-7bc6b1bf5a1c",
"company_code": "sample string 12",
"db_address_id": "03515703-0a59-4396-87f6-db0dd6639f3a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2b9f21c0-0a18-4a03-8cb4-ea0e75753762",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5f7d8116-2a4b-4ca0-964f-8a997c64140d",
"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-01-03T11:48:19.5089292+00:00",
"date_create": "2026-01-03T11:48:19.5089292+00:00",
"date_update": "2026-01-03T11:48:19.5089292+00:00",
"updated_by_user_id": "387606b7-2788-4ef0-8b62-a5fa5e563fb4",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-03T11:48:19.5089292+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-01-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-03T11:48:19.5089292+00:00",
"date_last_job": "2026-01-03T11:48:19.5089292+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-03T11:48:19.5089292+00:00",
"modified_dateutc": "2026-01-03T11:48:19.5089292+00:00",
"is_mobile_installation": true
},
"job_type_id": "7a1c5a59-fc34-458c-bf12-a32d42cbe4c3",
"job_type_code": "sample string 7",
"job_type": {
"id": "77966e3d-0498-4184-9cbf-d3babf802b29",
"name": "sample string 2",
"sales_organization_id": "e414367b-2988-40da-b57b-a9513c6626be",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-03T11:48:19.5089292+00:00",
"code": "sample string 7"
},
"job_priority_id": "8585d834-3b05-4078-a35a-50e7797ff779",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "78705da4-929f-46f3-ba92-fff9165e326a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "64763202-f968-4582-8876-f7f68a8a96d3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9ff0c68d-48b9-4dba-8aff-76260453b67e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b3cf18c-b83e-42f0-8e75-3e880e7ffda6",
"db_currency_id": "643f5faf-ce3a-4d7b-92bf-e6f9393452fd",
"db_language_id": "734ea462-2adb-4b0e-9c54-f6bedac7cd1f",
"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-01-03T11:48:19.5089292+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-03T11:48:19.5089292+00:00"
},
"job_status_id": "8ed1ce2c-d5b7-4680-a8b7-57f7051206dd",
"job_status_code": "sample string 11",
"db_address_id": "0d77ad32-8398-4214-9a26-f8ef4ab2a058",
"contact_id": "c9a23710-015c-40c2-9317-cbeb36bb740f",
"requested_by_company_id": "94b02c38-762b-43d8-ba89-bc9eb896964e",
"requested_by_contact_id": "d574badc-30f8-4bd0-a638-3ac7ea373f2c",
"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-01-03T11:48:19.5089292+00:00",
"due_date": "2026-01-03T11:48:19.5089292+00:00",
"date_create": "2026-01-03T11:48:19.5089292+00:00",
"date_update": "2026-01-03T11:48:19.5089292+00:00",
"date_closed": "2026-01-03T11:48:19.5089292+00:00",
"suggested_user_id": "6155e506-ba0c-45b6-9cc9-858b05e0e0b3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "17b568e1-8fab-4965-8631-e912d19b6d08",
"db_language_id": "86caac09-8b74-487e-9423-2dfcc1dc0e7f",
"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-01-03T11:48:19.5089292+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "41a9f48c-7ddb-4818-b1b6-f345bfa9d412",
"sales_organization": {
"id": "9ff0c68d-48b9-4dba-8aff-76260453b67e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b3cf18c-b83e-42f0-8e75-3e880e7ffda6",
"db_currency_id": "643f5faf-ce3a-4d7b-92bf-e6f9393452fd",
"db_language_id": "734ea462-2adb-4b0e-9c54-f6bedac7cd1f",
"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-01-03T11:48:19.5089292+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a69d44d9-1aaa-45d7-83fb-3777faccf8d5",
"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": "7e55323e-78ba-4a86-9e3a-a3e6d7a69180",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-03T11:48:19.5089292+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3a6abfd1-4708-49bf-a26e-047d98b86b8c"
},
"suggested_date_start": "2026-01-03T11:48:19.5089292+00:00",
"skill_id": "60238168-bad3-4799-963b-fea1f03f521d",
"skill_code": "sample string 32",
"skill": {
"id": "d61dbffc-a7b8-47e6-b415-12ef9b1ae560",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7231d48b-6e79-428c-9d01-2447b575fd0a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9ff0c68d-48b9-4dba-8aff-76260453b67e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b3cf18c-b83e-42f0-8e75-3e880e7ffda6",
"db_currency_id": "643f5faf-ce3a-4d7b-92bf-e6f9393452fd",
"db_language_id": "734ea462-2adb-4b0e-9c54-f6bedac7cd1f",
"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-01-03T11:48:19.5089292+00:00"
},
"modified_dateutc": "2026-01-03T11:48:19.5089292+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "309f8d33-cfc6-4589-8f4c-70494ca6e89f",
"date_reported_by_company": "2026-01-03T11:48:19.5089292+00:00",
"id2": 36,
"company_id": "f88ccc45-6398-4d1d-9c6f-fe913d974bb7",
"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": "b7247e78-9df3-4310-b686-680c463f3e23",
"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-01-03T11:48:19.5089292+00:00"
},
"work_instruction_details_id": "2375c872-8099-4be1-8b39-972b81455d79",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "74042ecc-a877-4940-87fd-0f7b4acce230",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e09e6f68-934c-4104-b75e-ccecf56031cd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-03T11:48:19.5089292+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": "5d2fd8ef-6698-46c4-a8c7-9dc9c9fc784c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-03T11:48:19.5089292+00:00"
}