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": "9453a3c8-0fd0-43b0-8b5c-86d838d5c21d",
"jobs_id": "ad189fa6-7938-48b2-a99a-ef521aaf7ee7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5b78b82a-58ef-4819-a8fd-4d9bfda54caf",
"_parent_id": "462dd51f-36f5-4696-b63a-b8597e64c29c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "336756c1-421b-4a4d-a0bc-5fb708052652",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d3315e13-7916-4640-9f65-7ebe954faa0f",
"_parent_id": "9a916b7a-94ee-454a-babd-d72cf4d5a628",
"root_parent_id": "8bd60851-0bbc-4c4b-80b6-c5968fee5693",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "74d44352-e999-4348-afaa-cef4694ebb67",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2b00dcba-d3a1-4afa-86b2-4516f4b6f0ae",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "01e5a52b-aaf0-4be0-ab2a-ca11f56c73c8",
"_parent_code": "sample string 6",
"sales_organization_id": "dc39d203-d08b-457b-a858-61d7d1526b15",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "25a89fb0-31e7-4219-bb5a-26274023b0d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8782ea7-45d6-4fd3-9e2f-9f5d8ba6d0fb",
"db_currency_id": "526b9860-8b6a-4dc1-a6f5-86cac4d8d818",
"db_language_id": "b54e404c-7bd5-41c7-a80f-79457da1abfd",
"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-31T06:41:24.7076311+00:00"
},
"modified_dateutc": "2025-12-31T06:41:24.7076311+00:00"
},
"equipment_model_id": "bffba6f6-9d6a-4817-adfb-1bb4f518456d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a326b1a3-a86d-414f-b64d-615587f95b30",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8ed6eec6-bec4-4e95-896f-fe240668d483",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "08b30f5d-599c-4a12-ba54-876d767ad223",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ec83ca1c-5005-4709-ae98-b80d3109c1f4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "25a89fb0-31e7-4219-bb5a-26274023b0d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8782ea7-45d6-4fd3-9e2f-9f5d8ba6d0fb",
"db_currency_id": "526b9860-8b6a-4dc1-a6f5-86cac4d8d818",
"db_language_id": "b54e404c-7bd5-41c7-a80f-79457da1abfd",
"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-31T06:41:24.7076311+00:00"
},
"modified_dateutc": "2025-12-31T06:41:24.7076311+00:00"
},
"equipment_family_id": "232373e5-5671-4747-8553-42be0008410d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2b00dcba-d3a1-4afa-86b2-4516f4b6f0ae",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "01e5a52b-aaf0-4be0-ab2a-ca11f56c73c8",
"_parent_code": "sample string 6",
"sales_organization_id": "dc39d203-d08b-457b-a858-61d7d1526b15",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "25a89fb0-31e7-4219-bb5a-26274023b0d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8782ea7-45d6-4fd3-9e2f-9f5d8ba6d0fb",
"db_currency_id": "526b9860-8b6a-4dc1-a6f5-86cac4d8d818",
"db_language_id": "b54e404c-7bd5-41c7-a80f-79457da1abfd",
"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-31T06:41:24.7076311+00:00"
},
"modified_dateutc": "2025-12-31T06:41:24.7076311+00:00"
},
"date_in_production_since": "2025-12-31T06:41:24.7076311+00:00",
"date_out_of_production_since": "2025-12-31T06:41:24.7076311+00:00",
"date_end_support": "2025-12-31T06:41:24.7076311+00:00",
"sales_organization_id": "43eec2b4-833b-4c27-b463-a12d1d600dec",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "25a89fb0-31e7-4219-bb5a-26274023b0d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8782ea7-45d6-4fd3-9e2f-9f5d8ba6d0fb",
"db_currency_id": "526b9860-8b6a-4dc1-a6f5-86cac4d8d818",
"db_language_id": "b54e404c-7bd5-41c7-a80f-79457da1abfd",
"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-31T06:41:24.7076311+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-31T06:41:24.7076311+00:00"
},
"project_status_id": "2da222e0-88da-4560-aed1-3ffe3f4b637d",
"project_status_code": "sample string 10",
"project_status": {
"id": "0ea9beff-bd1e-475f-bde8-e614db7a8f74",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8547890c-8ee7-4219-8874-3a339a4a16b8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "25a89fb0-31e7-4219-bb5a-26274023b0d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8782ea7-45d6-4fd3-9e2f-9f5d8ba6d0fb",
"db_currency_id": "526b9860-8b6a-4dc1-a6f5-86cac4d8d818",
"db_language_id": "b54e404c-7bd5-41c7-a80f-79457da1abfd",
"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-31T06:41:24.7076311+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-31T06:41:24.7076311+00:00"
},
"company_id": "d9f7e812-e34d-40aa-b945-94fc581cca78",
"company_code": "sample string 12",
"db_address_id": "e58390d7-8b4f-4c3e-a3cb-04b0b8403fc6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c7a59542-7e42-4612-b29c-99d32ee1a2e6",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "536a2b58-c20e-4133-8a28-9df940e4d4fa",
"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-31T06:41:24.7076311+00:00",
"date_create": "2025-12-31T06:41:24.7076311+00:00",
"date_update": "2025-12-31T06:41:24.7076311+00:00",
"updated_by_user_id": "e9bf443c-a726-4beb-9cca-8733e266fdab",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-31T06:41:24.7076311+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-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-31T06:41:24.7076311+00:00",
"date_last_job": "2025-12-31T06:41:24.7076311+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-31T06:41:24.7076311+00:00",
"modified_dateutc": "2025-12-31T06:41:24.7076311+00:00",
"is_mobile_installation": true
},
"job_type_id": "8d580ebc-f2d1-4d90-9bcb-92564d033388",
"job_type_code": "sample string 7",
"job_type": {
"id": "2a064123-cdb1-4f67-9554-f99256bd7e3c",
"name": "sample string 2",
"sales_organization_id": "fcd4ffca-5964-43a4-8139-10a1ca2d8225",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-31T06:41:24.7076311+00:00",
"code": "sample string 7"
},
"job_priority_id": "c2e28a76-9ad4-47b8-bc77-64df5f2b82a4",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "373a1cfb-7a14-4d17-ac7c-84c427364bf5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "21bd9143-76ac-4b97-9f13-07b13429704f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "25a89fb0-31e7-4219-bb5a-26274023b0d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8782ea7-45d6-4fd3-9e2f-9f5d8ba6d0fb",
"db_currency_id": "526b9860-8b6a-4dc1-a6f5-86cac4d8d818",
"db_language_id": "b54e404c-7bd5-41c7-a80f-79457da1abfd",
"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-31T06:41:24.7076311+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-31T06:41:24.7076311+00:00"
},
"job_status_id": "5a9d8196-1e33-4ba2-a595-00038a0e360c",
"job_status_code": "sample string 11",
"db_address_id": "1a848e05-4423-4cbc-89a4-c7123466d618",
"contact_id": "6d696646-6277-4aa0-bb02-b8bf6650094f",
"requested_by_company_id": "c6b34e89-f65d-4cad-aca1-eb524c1bf50f",
"requested_by_contact_id": "24594c0f-9acc-458c-b89a-4c2620d2951c",
"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-31T06:41:24.7076311+00:00",
"due_date": "2025-12-31T06:41:24.7076311+00:00",
"date_create": "2025-12-31T06:41:24.7076311+00:00",
"date_update": "2025-12-31T06:41:24.7076311+00:00",
"date_closed": "2025-12-31T06:41:24.7076311+00:00",
"suggested_user_id": "21584cd0-2ed5-42bc-9aca-ed1814559344",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "48cd275d-1516-4318-82ca-9d794cb7717d",
"db_language_id": "7a159912-bc64-4f9d-a40b-bc5cf8d025c6",
"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-31T06:41:24.7076311+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e5173df8-d436-4b6e-944d-a49f40224ec0",
"sales_organization": {
"id": "25a89fb0-31e7-4219-bb5a-26274023b0d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8782ea7-45d6-4fd3-9e2f-9f5d8ba6d0fb",
"db_currency_id": "526b9860-8b6a-4dc1-a6f5-86cac4d8d818",
"db_language_id": "b54e404c-7bd5-41c7-a80f-79457da1abfd",
"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-31T06:41:24.7076311+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b8c9bf1d-6641-4ce1-9ad7-25bc9cce49ef",
"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": "9c0f2b56-a56e-4780-9409-26bb4c1372f3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-31T06:41:24.7076311+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7a977dbb-592d-463a-8ac4-f4b496599614"
},
"suggested_date_start": "2025-12-31T06:41:24.7076311+00:00",
"skill_id": "d7646b54-46ef-462b-bfd8-2d4bc7dddde7",
"skill_code": "sample string 32",
"skill": {
"id": "7f79216b-ed2e-4ecc-b163-0f8effd82bef",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8e24f4c7-7ed0-4201-ad79-935f60d41414",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "25a89fb0-31e7-4219-bb5a-26274023b0d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8782ea7-45d6-4fd3-9e2f-9f5d8ba6d0fb",
"db_currency_id": "526b9860-8b6a-4dc1-a6f5-86cac4d8d818",
"db_language_id": "b54e404c-7bd5-41c7-a80f-79457da1abfd",
"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-31T06:41:24.7076311+00:00"
},
"modified_dateutc": "2025-12-31T06:41:24.7076311+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7f46009b-ed87-4cc6-adb6-4a6a082fa6ad",
"date_reported_by_company": "2025-12-31T06:41:24.7076311+00:00",
"id2": 36,
"company_id": "69f2f41a-0d96-40f5-aba6-f0c801d8d1dc",
"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": "076b3d65-662b-4a15-bcb8-8650a8386447",
"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-31T06:41:24.7076311+00:00"
},
"work_instruction_details_id": "a7029cce-2659-46c9-892f-4bf0aee40e7c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "815c607c-01e6-4c45-94e5-109189c5d373",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "300ff7cd-db3c-41d8-9298-783e3c84bde9",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-31T06:41:24.7076311+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": "44a5bc61-f071-4de3-aba3-97dafb1fce02",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-31T06:41:24.7076311+00:00"
}