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": "b144ded0-c7d1-40fe-9c72-43e4ad96d7f7",
"jobs_id": "5fc480d0-7d48-475b-a329-822eeccba987",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "33993a60-593d-4a94-b6e8-d700336b81bf",
"_parent_id": "a7ac79bd-1bee-4a60-b77f-43be26a5e829",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0c8f34a4-13b0-49a8-a363-8f256d85583a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0d98bd30-de3b-4a83-bf21-f1441b26ed25",
"_parent_id": "5745cd9a-449b-4cdb-8cee-e647d028a3e1",
"root_parent_id": "15bece32-b24f-4330-8fd2-5e5335cbdab9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "33f2af76-411e-4d28-96c3-ca2853a93024",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c4254f1b-3abe-4e09-8907-a6317203a4e4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f48faa3f-cdc0-4c77-af32-60204b7c045c",
"_parent_code": "sample string 6",
"sales_organization_id": "b7cf3db6-0024-4981-af0a-936a0eba47f5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b4b7965d-d8a6-4117-b6c0-5e96d9d5d1a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bca8a711-e047-4df2-a2f6-be50b38a91e5",
"db_currency_id": "6b7cbbfc-a398-4042-ac6e-d1afa0751767",
"db_language_id": "62d59f3f-4b6a-49e6-944a-d08fdf406611",
"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-10-24T11:53:28.720491+00:00"
},
"modified_dateutc": "2026-10-24T11:53:28.720491+00:00"
},
"equipment_model_id": "549cc609-5809-479d-a65d-af6ff95716c9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ab443744-f7c8-4a06-b4e2-327266e8e6ea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c7c0c81b-c568-48ed-ba27-96ec6acd7816",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "68e3740f-6b87-4bc7-867b-d0af4fa811a8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7a448b55-f55b-449d-812a-4a15be902220",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b4b7965d-d8a6-4117-b6c0-5e96d9d5d1a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bca8a711-e047-4df2-a2f6-be50b38a91e5",
"db_currency_id": "6b7cbbfc-a398-4042-ac6e-d1afa0751767",
"db_language_id": "62d59f3f-4b6a-49e6-944a-d08fdf406611",
"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-10-24T11:53:28.720491+00:00"
},
"modified_dateutc": "2026-10-24T11:53:28.720491+00:00"
},
"equipment_family_id": "30acd38a-cef9-430b-bd93-9a7d8f1d46ba",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c4254f1b-3abe-4e09-8907-a6317203a4e4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f48faa3f-cdc0-4c77-af32-60204b7c045c",
"_parent_code": "sample string 6",
"sales_organization_id": "b7cf3db6-0024-4981-af0a-936a0eba47f5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b4b7965d-d8a6-4117-b6c0-5e96d9d5d1a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bca8a711-e047-4df2-a2f6-be50b38a91e5",
"db_currency_id": "6b7cbbfc-a398-4042-ac6e-d1afa0751767",
"db_language_id": "62d59f3f-4b6a-49e6-944a-d08fdf406611",
"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-10-24T11:53:28.720491+00:00"
},
"modified_dateutc": "2026-10-24T11:53:28.720491+00:00"
},
"date_in_production_since": "2026-10-24T11:53:28.720491+00:00",
"date_out_of_production_since": "2026-10-24T11:53:28.720491+00:00",
"date_end_support": "2026-10-24T11:53:28.720491+00:00",
"sales_organization_id": "bf67e166-7139-48be-aa8c-de7fe2a19e93",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b4b7965d-d8a6-4117-b6c0-5e96d9d5d1a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bca8a711-e047-4df2-a2f6-be50b38a91e5",
"db_currency_id": "6b7cbbfc-a398-4042-ac6e-d1afa0751767",
"db_language_id": "62d59f3f-4b6a-49e6-944a-d08fdf406611",
"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-10-24T11:53:28.720491+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-10-24T11:53:28.720491+00:00"
},
"project_status_id": "e37a10d7-5f40-44f8-a378-f158a5d5f1c5",
"project_status_code": "sample string 10",
"project_status": {
"id": "46fd0689-e666-42cc-a8a9-3b47ad8344ae",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1929785d-16b7-4fc7-98ad-9158beaa62eb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b4b7965d-d8a6-4117-b6c0-5e96d9d5d1a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bca8a711-e047-4df2-a2f6-be50b38a91e5",
"db_currency_id": "6b7cbbfc-a398-4042-ac6e-d1afa0751767",
"db_language_id": "62d59f3f-4b6a-49e6-944a-d08fdf406611",
"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-10-24T11:53:28.720491+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-24T11:53:28.720491+00:00"
},
"company_id": "efe1f37d-620e-46b8-9942-31179df75fd6",
"company_code": "sample string 12",
"db_address_id": "70904b11-6d8f-42d1-a381-5ecf9d12fcf1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f5d6626b-dbcb-471a-895f-8a6840a77d0c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "68420f94-7c12-4012-887b-a598f03b8410",
"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-10-24T11:53:28.720491+00:00",
"date_create": "2026-10-24T11:53:28.720491+00:00",
"date_update": "2026-10-24T11:53:28.720491+00:00",
"updated_by_user_id": "3779651f-d83a-4a05-9cf9-92788d234a63",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-24T11:53:28.720491+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-10-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-24T11:53:28.720491+00:00",
"date_last_job": "2026-10-24T11:53:28.720491+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-24T11:53:28.720491+00:00",
"modified_dateutc": "2026-10-24T11:53:28.720491+00:00",
"is_mobile_installation": true
},
"job_type_id": "cb635c2c-8174-4252-be7a-3d7051baca2c",
"job_type_code": "sample string 7",
"job_type": {
"id": "e2187c1b-c546-4e76-9f21-a8f9f3809b82",
"name": "sample string 2",
"sales_organization_id": "a78ae4e3-4767-4085-a89c-7e2229b88d02",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-24T11:53:28.720491+00:00",
"code": "sample string 7"
},
"job_priority_id": "8a648fd3-04c6-48da-862f-040af96b9e5b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e0690414-44ec-4317-88bd-4c8fdca63e57",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c492142a-af86-438f-9048-cbd63a73dcec",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b4b7965d-d8a6-4117-b6c0-5e96d9d5d1a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bca8a711-e047-4df2-a2f6-be50b38a91e5",
"db_currency_id": "6b7cbbfc-a398-4042-ac6e-d1afa0751767",
"db_language_id": "62d59f3f-4b6a-49e6-944a-d08fdf406611",
"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-10-24T11:53:28.720491+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-24T11:53:28.720491+00:00"
},
"job_status_id": "c4708424-59cc-4953-bd18-951fcded73f4",
"job_status_code": "sample string 11",
"db_address_id": "6a4b10c6-e26e-4a18-be7f-54c4cf9e5d1b",
"contact_id": "150e281e-038c-4aef-af7f-20dd011dd337",
"requested_by_company_id": "a1bab61f-e1f3-4d98-a28a-eb32c89810fb",
"requested_by_contact_id": "d9cc5e90-23e8-425a-90fa-42c20ce64cf9",
"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-10-24T11:53:28.720491+00:00",
"due_date": "2026-10-24T11:53:28.720491+00:00",
"date_create": "2026-10-24T11:53:28.720491+00:00",
"date_update": "2026-10-24T11:53:28.720491+00:00",
"date_closed": "2026-10-24T11:53:28.720491+00:00",
"suggested_user_id": "5cf1d330-64aa-4d3d-b8da-a49311b19583",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "90e045d2-6546-436b-9106-b76f1bf173ae",
"db_language_id": "7e69cc6c-dd74-4ee6-95b2-c8f5140c323f",
"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-10-24T11:53:28.720491+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "32ef1e21-2012-4147-b702-f8423362b7d8",
"sales_organization": {
"id": "b4b7965d-d8a6-4117-b6c0-5e96d9d5d1a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bca8a711-e047-4df2-a2f6-be50b38a91e5",
"db_currency_id": "6b7cbbfc-a398-4042-ac6e-d1afa0751767",
"db_language_id": "62d59f3f-4b6a-49e6-944a-d08fdf406611",
"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-10-24T11:53:28.720491+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "dd9644dd-062a-47e2-a39a-44899d53a733",
"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": "682fab5a-f9d3-4311-86c9-d3c8d0c56ba1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-24T11:53:28.720491+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3a9046a8-10a9-44b1-b499-4e647074c699"
},
"suggested_date_start": "2026-10-24T11:53:28.720491+00:00",
"skill_id": "274116f4-77a9-4a33-91c6-5b764a7ab061",
"skill_code": "sample string 32",
"skill": {
"id": "8be22fd1-b103-4980-a088-69990a93799d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "32d5c95b-85ae-4edb-8cfa-26dbb3e22221",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b4b7965d-d8a6-4117-b6c0-5e96d9d5d1a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bca8a711-e047-4df2-a2f6-be50b38a91e5",
"db_currency_id": "6b7cbbfc-a398-4042-ac6e-d1afa0751767",
"db_language_id": "62d59f3f-4b6a-49e6-944a-d08fdf406611",
"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-10-24T11:53:28.720491+00:00"
},
"modified_dateutc": "2026-10-24T11:53:28.720491+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ef91fd27-ec6d-46e0-b061-6ef1c7f42265",
"date_reported_by_company": "2026-10-24T11:53:28.720491+00:00",
"id2": 36,
"company_id": "e8bd33ff-8e5f-4762-a02a-9198bbf8f109",
"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": "e2b49850-8c1f-4aca-9f56-ca87529f1513",
"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-10-24T11:53:28.720491+00:00"
},
"work_instruction_details_id": "e96be9a5-4644-41f5-b001-b5c755f6bfba",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b6c504d9-cbdb-4bf9-83eb-aa3d1f794cac",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d65cf9d5-0263-4789-8748-f787f873c8c3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-24T11:53:28.720491+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": "e4196de4-01a1-494f-ba88-8366f203ff90",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-24T11:53:28.720491+00:00"
}