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": "d4f8f256-5c75-4bf1-8992-24c9144016b5",
"jobs_id": "c0b65200-2914-41aa-bc81-06104aa1ea7f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6e88ac23-6287-4a63-a244-90daf8381735",
"_parent_id": "6cb46125-abfc-4715-a2fc-560119441ecd",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0e93a399-b8f0-470a-8e43-2d2433209d6e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8a20f085-4958-43fc-bca9-4f7029a682a6",
"_parent_id": "91e9894d-ebeb-4795-8640-4858efc43b5f",
"root_parent_id": "658c4994-aec4-4fbb-9651-8ab38034f8f2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6cde5caa-0189-4cd1-b291-54703344d8e3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "56f09102-c77b-44b8-a506-76f762d4969e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8560fbef-dc96-41e6-b6e9-dc40a7b90199",
"_parent_code": "sample string 6",
"sales_organization_id": "699f9e38-96b4-499c-b203-42a139f10e44",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b68b2e6c-665b-448c-8e80-ac13a55ccdfe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef5c429d-37c6-4ff6-925b-bf6e0f09e0eb",
"db_currency_id": "2c25f429-5ffa-4ac5-9d04-81263f32ca29",
"db_language_id": "3a051aca-430c-42d7-be7e-6aec7e61eb12",
"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-11T20:53:10.506467+00:00"
},
"modified_dateutc": "2026-09-11T20:53:10.506467+00:00"
},
"equipment_model_id": "4105e355-a583-4d93-93f9-8a0b616751ba",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e3adc1fc-b2ae-4352-92b2-75f3b2b66e0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7fd2a4f3-a713-4dc7-b82f-46f9d90da6fe",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ad59928c-7180-4285-8594-858975d12817",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "51ff8e6e-5685-48a9-bb1e-ebaaa151c513",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b68b2e6c-665b-448c-8e80-ac13a55ccdfe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef5c429d-37c6-4ff6-925b-bf6e0f09e0eb",
"db_currency_id": "2c25f429-5ffa-4ac5-9d04-81263f32ca29",
"db_language_id": "3a051aca-430c-42d7-be7e-6aec7e61eb12",
"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-11T20:53:10.506467+00:00"
},
"modified_dateutc": "2026-09-11T20:53:10.506467+00:00"
},
"equipment_family_id": "9363a75f-a85d-4a5a-8105-22ee2b525ed3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "56f09102-c77b-44b8-a506-76f762d4969e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8560fbef-dc96-41e6-b6e9-dc40a7b90199",
"_parent_code": "sample string 6",
"sales_organization_id": "699f9e38-96b4-499c-b203-42a139f10e44",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b68b2e6c-665b-448c-8e80-ac13a55ccdfe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef5c429d-37c6-4ff6-925b-bf6e0f09e0eb",
"db_currency_id": "2c25f429-5ffa-4ac5-9d04-81263f32ca29",
"db_language_id": "3a051aca-430c-42d7-be7e-6aec7e61eb12",
"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-11T20:53:10.506467+00:00"
},
"modified_dateutc": "2026-09-11T20:53:10.506467+00:00"
},
"date_in_production_since": "2026-09-11T20:53:10.506467+00:00",
"date_out_of_production_since": "2026-09-11T20:53:10.506467+00:00",
"date_end_support": "2026-09-11T20:53:10.506467+00:00",
"sales_organization_id": "74c07918-c653-439b-a634-38ff8efa496e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b68b2e6c-665b-448c-8e80-ac13a55ccdfe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef5c429d-37c6-4ff6-925b-bf6e0f09e0eb",
"db_currency_id": "2c25f429-5ffa-4ac5-9d04-81263f32ca29",
"db_language_id": "3a051aca-430c-42d7-be7e-6aec7e61eb12",
"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-11T20:53:10.506467+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-11T20:53:10.506467+00:00"
},
"project_status_id": "5b76aab8-7074-4493-b351-5a3c7a4e6dbc",
"project_status_code": "sample string 10",
"project_status": {
"id": "8fd3e666-b057-426d-98e8-f71351280120",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "92c4f7ea-bb33-45da-bcc9-fa024af0f115",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b68b2e6c-665b-448c-8e80-ac13a55ccdfe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef5c429d-37c6-4ff6-925b-bf6e0f09e0eb",
"db_currency_id": "2c25f429-5ffa-4ac5-9d04-81263f32ca29",
"db_language_id": "3a051aca-430c-42d7-be7e-6aec7e61eb12",
"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-11T20:53:10.506467+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-11T20:53:10.506467+00:00"
},
"company_id": "9592b658-8c54-4d1d-85d9-20661658aad3",
"company_code": "sample string 12",
"db_address_id": "c0f58a8b-1bcd-4ae1-9468-12bf009f9597",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6fb352fc-420f-43f8-903d-fb327b4c7931",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7886a52b-1288-4198-897f-10996e39ef21",
"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-11T20:53:10.506467+00:00",
"date_create": "2026-09-11T20:53:10.506467+00:00",
"date_update": "2026-09-11T20:53:10.506467+00:00",
"updated_by_user_id": "a0dff913-036c-4343-bd75-167bae3cb95c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-11T20:53:10.506467+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-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-11T20:53:10.506467+00:00",
"date_last_job": "2026-09-11T20:53:10.506467+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-11T20:53:10.506467+00:00",
"modified_dateutc": "2026-09-11T20:53:10.506467+00:00",
"is_mobile_installation": true
},
"job_type_id": "5f775a70-83f4-4333-9435-36a213e3e71e",
"job_type_code": "sample string 7",
"job_type": {
"id": "b6dba643-be95-44d4-9598-b1712178f440",
"name": "sample string 2",
"sales_organization_id": "bd2fd167-9c0d-43d1-8357-51915adaba57",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-11T20:53:10.506467+00:00",
"code": "sample string 7"
},
"job_priority_id": "d74fa5a3-5542-4541-9b49-26d7f09950c2",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6c406517-f198-4c4a-a40e-9b695ca2bb2e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2a7c75f7-95f9-41ee-a153-d65941814f09",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b68b2e6c-665b-448c-8e80-ac13a55ccdfe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef5c429d-37c6-4ff6-925b-bf6e0f09e0eb",
"db_currency_id": "2c25f429-5ffa-4ac5-9d04-81263f32ca29",
"db_language_id": "3a051aca-430c-42d7-be7e-6aec7e61eb12",
"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-11T20:53:10.506467+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-11T20:53:10.506467+00:00"
},
"job_status_id": "fbd6629e-b5a4-467f-ae67-8be9bd05755e",
"job_status_code": "sample string 11",
"db_address_id": "12795c5f-be0d-4e23-8a1e-23efb2d35119",
"contact_id": "8c47fc85-f163-4460-ae0b-32214e3be624",
"requested_by_company_id": "704bd3cd-f966-47f9-8e3d-206190d6cc55",
"requested_by_contact_id": "ff94e04a-045d-409e-8ecd-fb46dd95c0ea",
"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-11T20:53:10.506467+00:00",
"due_date": "2026-09-11T20:53:10.506467+00:00",
"date_create": "2026-09-11T20:53:10.506467+00:00",
"date_update": "2026-09-11T20:53:10.506467+00:00",
"date_closed": "2026-09-11T20:53:10.506467+00:00",
"suggested_user_id": "ec9007c1-ec61-4bb2-aaa1-68355e1d9487",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c745be67-6e0b-496b-b2e5-53a6425376a3",
"db_language_id": "b8816c9b-9410-468f-b1c3-d43b1971ad4e",
"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-11T20:53:10.506467+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ddd20783-8e71-4bfc-aaaa-aef15ae76db7",
"sales_organization": {
"id": "b68b2e6c-665b-448c-8e80-ac13a55ccdfe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef5c429d-37c6-4ff6-925b-bf6e0f09e0eb",
"db_currency_id": "2c25f429-5ffa-4ac5-9d04-81263f32ca29",
"db_language_id": "3a051aca-430c-42d7-be7e-6aec7e61eb12",
"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-11T20:53:10.506467+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "38f74fff-db96-4f5d-b6d2-11c88efb1a49",
"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": "5e5220c8-4bed-48ee-8005-77f41c720817",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-11T20:53:10.506467+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ed10aecf-50a0-497a-b7be-0ce023d153df"
},
"suggested_date_start": "2026-09-11T20:53:10.506467+00:00",
"skill_id": "4162aefb-b6bd-4dbc-904f-a5960a558280",
"skill_code": "sample string 32",
"skill": {
"id": "cb2fc528-0203-4552-9657-7a2cf057c53a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "cfabc8eb-f8e7-4053-9b6b-95dfc9991dea",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b68b2e6c-665b-448c-8e80-ac13a55ccdfe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef5c429d-37c6-4ff6-925b-bf6e0f09e0eb",
"db_currency_id": "2c25f429-5ffa-4ac5-9d04-81263f32ca29",
"db_language_id": "3a051aca-430c-42d7-be7e-6aec7e61eb12",
"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-11T20:53:10.506467+00:00"
},
"modified_dateutc": "2026-09-11T20:53:10.506467+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ef9270d4-aa10-41b0-a224-bce9a741226f",
"date_reported_by_company": "2026-09-11T20:53:10.506467+00:00",
"id2": 36,
"company_id": "a03b1fe0-c067-49de-92fa-699c53d0b093",
"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": "d53c37b3-e154-4ab1-8daf-902dfeceb7e1",
"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-11T20:53:10.506467+00:00"
},
"work_instruction_details_id": "f8d9a2b5-5d6f-4e97-a046-83a17b371437",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "065f8282-75f3-4ebf-b0cf-5c06ed9ae229",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ed2b2d2b-8b47-4fc7-ac77-ef11c3d64c3b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-11T20:53:10.506467+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": "b46ec756-d600-4b00-b89a-49cda03fa63d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-11T20:53:10.506467+00:00"
}