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": "0af38106-3a2d-4956-8036-7d252b45a9a8",
"jobs_id": "f02d5db8-a01d-4993-af07-7f7a9f045f2d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e647ee59-c603-4b3a-a8db-71890278a00a",
"_parent_id": "37c3aa0b-15be-4eeb-bff5-a36f2ca6d8c6",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "22344843-7535-4678-bf5c-e137e2fb9d63",
"project_reference_back_office": "sample string 5",
"project": {
"id": "aabf73bb-ca4d-4da0-b234-0761e8b6d381",
"_parent_id": "790ab163-bf91-448d-953f-d706462b7aa8",
"root_parent_id": "e8f8eb23-d322-4689-a4c1-000cca643a8d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ab9aaf8b-05ad-4786-975d-b6c40576b69a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9ff7801d-d20a-456c-a779-3e9c56b773ed",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "abdb2073-932a-4cd0-9027-0d4fb0e987e0",
"_parent_code": "sample string 6",
"sales_organization_id": "8ee1bd08-4d67-4bc3-bb5a-89b67f3e28a3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c57a9d09-5013-412c-b2ae-e609643f3e59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16be37e2-c14a-4e51-a257-c51239fc35ce",
"db_currency_id": "93728415-171a-4b36-ade9-311436bc1f94",
"db_language_id": "2339b93e-68b4-494d-a9a3-0ec62d94c906",
"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-14T01:56:38.393304+00:00"
},
"modified_dateutc": "2026-09-14T01:56:38.393304+00:00"
},
"equipment_model_id": "0d60b994-53ec-4d4e-9a82-83f764f8cfbf",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ffcc4b28-0558-4413-80fe-e98f7759745d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "63e1d484-57c6-4ba5-a994-5a66f952ef42",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0fb9385c-9d59-4307-b39e-1abd13d82839",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3a62701e-9cf5-4a56-ab9d-ffbe9b603ef9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c57a9d09-5013-412c-b2ae-e609643f3e59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16be37e2-c14a-4e51-a257-c51239fc35ce",
"db_currency_id": "93728415-171a-4b36-ade9-311436bc1f94",
"db_language_id": "2339b93e-68b4-494d-a9a3-0ec62d94c906",
"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-14T01:56:38.393304+00:00"
},
"modified_dateutc": "2026-09-14T01:56:38.393304+00:00"
},
"equipment_family_id": "7b979c14-f291-41bd-a866-3bd39edca3fc",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9ff7801d-d20a-456c-a779-3e9c56b773ed",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "abdb2073-932a-4cd0-9027-0d4fb0e987e0",
"_parent_code": "sample string 6",
"sales_organization_id": "8ee1bd08-4d67-4bc3-bb5a-89b67f3e28a3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c57a9d09-5013-412c-b2ae-e609643f3e59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16be37e2-c14a-4e51-a257-c51239fc35ce",
"db_currency_id": "93728415-171a-4b36-ade9-311436bc1f94",
"db_language_id": "2339b93e-68b4-494d-a9a3-0ec62d94c906",
"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-14T01:56:38.393304+00:00"
},
"modified_dateutc": "2026-09-14T01:56:38.393304+00:00"
},
"date_in_production_since": "2026-09-14T01:56:38.393304+00:00",
"date_out_of_production_since": "2026-09-14T01:56:38.393304+00:00",
"date_end_support": "2026-09-14T01:56:38.393304+00:00",
"sales_organization_id": "7237de9c-f45a-4f65-b8fe-4bf09a34adfa",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c57a9d09-5013-412c-b2ae-e609643f3e59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16be37e2-c14a-4e51-a257-c51239fc35ce",
"db_currency_id": "93728415-171a-4b36-ade9-311436bc1f94",
"db_language_id": "2339b93e-68b4-494d-a9a3-0ec62d94c906",
"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-14T01:56:38.393304+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-14T01:56:38.393304+00:00"
},
"project_status_id": "2be8613c-f82f-4dee-9c81-6c5d0cef4ea3",
"project_status_code": "sample string 10",
"project_status": {
"id": "42a0b068-7795-4bd9-a31e-05a9c288c5e8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0549af0f-1e75-44a4-9a4b-4db5bbd30702",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c57a9d09-5013-412c-b2ae-e609643f3e59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16be37e2-c14a-4e51-a257-c51239fc35ce",
"db_currency_id": "93728415-171a-4b36-ade9-311436bc1f94",
"db_language_id": "2339b93e-68b4-494d-a9a3-0ec62d94c906",
"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-14T01:56:38.393304+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-14T01:56:38.393304+00:00"
},
"company_id": "3e9029a3-e234-4576-91a8-2ba9983168ec",
"company_code": "sample string 12",
"db_address_id": "3927553d-4c26-4b96-a0eb-e788003fe5d3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "27f476dc-e3bf-45f4-9c10-59f9fe3e19a3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "240b182d-f46e-46c9-b6f4-6e07296e7e58",
"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-14T01:56:38.393304+00:00",
"date_create": "2026-09-14T01:56:38.393304+00:00",
"date_update": "2026-09-14T01:56:38.393304+00:00",
"updated_by_user_id": "c56ab091-8658-4bed-b514-6c553018a1dd",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-14T01:56:38.393304+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-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-14T01:56:38.393304+00:00",
"date_last_job": "2026-09-14T01:56:38.393304+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-14T01:56:38.393304+00:00",
"modified_dateutc": "2026-09-14T01:56:38.393304+00:00",
"is_mobile_installation": true
},
"job_type_id": "d96c79e9-d0bd-4fe1-9d64-5831d9f3ae70",
"job_type_code": "sample string 7",
"job_type": {
"id": "41e88d78-6512-4fe4-a4e1-c3c570f97891",
"name": "sample string 2",
"sales_organization_id": "9c9f9ee2-30a2-46a9-97ad-fe050a80e47d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-14T01:56:38.393304+00:00",
"code": "sample string 7"
},
"job_priority_id": "a8ff3727-5426-4fdb-a4c6-50184f85ca7c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "13fc8223-0632-46c9-a8f0-58628a00fa8b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "43d61159-983f-483c-92e5-7bc5126cd36f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c57a9d09-5013-412c-b2ae-e609643f3e59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16be37e2-c14a-4e51-a257-c51239fc35ce",
"db_currency_id": "93728415-171a-4b36-ade9-311436bc1f94",
"db_language_id": "2339b93e-68b4-494d-a9a3-0ec62d94c906",
"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-14T01:56:38.393304+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-14T01:56:38.393304+00:00"
},
"job_status_id": "028574f8-f8c4-4930-ad09-1850f5c6aa9a",
"job_status_code": "sample string 11",
"db_address_id": "f71dc0b6-4687-447e-b844-c94a5ad3553d",
"contact_id": "bac0349b-6adf-4008-8bab-3a15fd95e904",
"requested_by_company_id": "65acdf7e-eac6-46cc-8b80-0a84e0faecf2",
"requested_by_contact_id": "01a37494-0117-43c3-85de-df8c07f4d8e3",
"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-14T01:56:38.393304+00:00",
"due_date": "2026-09-14T01:56:38.393304+00:00",
"date_create": "2026-09-14T01:56:38.393304+00:00",
"date_update": "2026-09-14T01:56:38.393304+00:00",
"date_closed": "2026-09-14T01:56:38.393304+00:00",
"suggested_user_id": "dce88ec8-4233-42e8-afe2-4410e9815d33",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d81a6b2d-faf8-4265-8397-90c5c1016e0c",
"db_language_id": "55943084-fed1-4f26-a465-f4b7edc5c8e3",
"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-14T01:56:38.393304+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "154bd144-18dc-4f06-b92d-035383759634",
"sales_organization": {
"id": "c57a9d09-5013-412c-b2ae-e609643f3e59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16be37e2-c14a-4e51-a257-c51239fc35ce",
"db_currency_id": "93728415-171a-4b36-ade9-311436bc1f94",
"db_language_id": "2339b93e-68b4-494d-a9a3-0ec62d94c906",
"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-14T01:56:38.393304+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0847d0fd-1975-4f91-b624-99532d14ebbb",
"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": "7d5de13a-a898-400a-a194-cc51fb957623",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-14T01:56:38.393304+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d1d834ec-c98b-43e7-9251-4ed6d6c46ea1"
},
"suggested_date_start": "2026-09-14T01:56:38.393304+00:00",
"skill_id": "97090378-8780-43b6-8591-a01b052691b6",
"skill_code": "sample string 32",
"skill": {
"id": "42c485cd-1708-45c0-b260-238164f34eb2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "cec0ba07-1918-4789-bb35-3dfa38d86929",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c57a9d09-5013-412c-b2ae-e609643f3e59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16be37e2-c14a-4e51-a257-c51239fc35ce",
"db_currency_id": "93728415-171a-4b36-ade9-311436bc1f94",
"db_language_id": "2339b93e-68b4-494d-a9a3-0ec62d94c906",
"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-14T01:56:38.393304+00:00"
},
"modified_dateutc": "2026-09-14T01:56:38.393304+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "187cf21e-3e2f-413b-963d-01e4d444960b",
"date_reported_by_company": "2026-09-14T01:56:38.393304+00:00",
"id2": 36,
"company_id": "ec0cddcf-3b01-4364-bd7b-86bfcf60e34a",
"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": "071d322e-095c-4603-8da1-baf61da6c2e2",
"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-14T01:56:38.393304+00:00"
},
"work_instruction_details_id": "5da687d0-1f82-4a63-a992-1f2c1bdcb91f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c3bc5c0a-a84d-429a-b3be-0f8b61c6565d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "00dbe9e2-d7ee-4355-88ac-1125f4d04fab",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-14T01:56:38.393304+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": "67fafc54-82d1-4a93-896f-4361ebb3723f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-14T01:56:38.393304+00:00"
}