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": "408410d0-4d81-401f-9dab-1757c681d0c4",
"jobs_id": "5450915d-72b5-48c8-9a97-937eb690a7f5",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "476a5dd7-66ea-4e9d-9a5c-ac78125810e1",
"_parent_id": "c0030eac-9f6c-4684-9144-e0ca72f2fb23",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6a5717f5-90e2-4163-aa29-eb8742e88d57",
"project_reference_back_office": "sample string 5",
"project": {
"id": "34737883-d332-42d2-88c1-027d2fe8471c",
"_parent_id": "f4b07418-b169-46bb-b8db-827d6a617ee2",
"root_parent_id": "e390f18a-b545-410c-b554-f1280c474b3e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "74a55e58-12dd-4d89-92dd-d791b4d227a1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "36099edc-8823-4a5e-ba8f-e19e6dbbcd84",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2bcfbd76-70d1-41fc-be58-7b87c98e89fe",
"_parent_code": "sample string 6",
"sales_organization_id": "99afe318-bc92-4e44-8b93-33af3d519f49",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "40b5fcd7-a5d2-4186-8205-e1fd1f0b2ef5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "468411af-11be-488a-b8a6-33f91c888a52",
"db_currency_id": "22e11863-7cf7-42dc-85e6-6d964df479dc",
"db_language_id": "a57e255d-00ec-48e1-a708-6b60b62416ec",
"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-19T10:35:44.3214387+00:00"
},
"modified_dateutc": "2026-01-19T10:35:44.3214387+00:00"
},
"equipment_model_id": "df6f99f0-6fd4-4163-9c14-9bf33e718f32",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "cc47abb4-64d8-4e8a-bd3a-57f22383eb01",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "252aeab8-caab-44a3-8b4b-97c7e20e8f59",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f1359d13-45ec-4830-9890-da5ab544d46c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "88193d8b-8035-4947-887e-9d07ff4a6bd1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "40b5fcd7-a5d2-4186-8205-e1fd1f0b2ef5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "468411af-11be-488a-b8a6-33f91c888a52",
"db_currency_id": "22e11863-7cf7-42dc-85e6-6d964df479dc",
"db_language_id": "a57e255d-00ec-48e1-a708-6b60b62416ec",
"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-19T10:35:44.3214387+00:00"
},
"modified_dateutc": "2026-01-19T10:35:44.3214387+00:00"
},
"equipment_family_id": "bdea07f3-5239-45a0-9d09-30e6f890bc40",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "36099edc-8823-4a5e-ba8f-e19e6dbbcd84",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2bcfbd76-70d1-41fc-be58-7b87c98e89fe",
"_parent_code": "sample string 6",
"sales_organization_id": "99afe318-bc92-4e44-8b93-33af3d519f49",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "40b5fcd7-a5d2-4186-8205-e1fd1f0b2ef5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "468411af-11be-488a-b8a6-33f91c888a52",
"db_currency_id": "22e11863-7cf7-42dc-85e6-6d964df479dc",
"db_language_id": "a57e255d-00ec-48e1-a708-6b60b62416ec",
"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-19T10:35:44.3214387+00:00"
},
"modified_dateutc": "2026-01-19T10:35:44.3214387+00:00"
},
"date_in_production_since": "2026-01-19T10:35:44.3214387+00:00",
"date_out_of_production_since": "2026-01-19T10:35:44.3214387+00:00",
"date_end_support": "2026-01-19T10:35:44.3214387+00:00",
"sales_organization_id": "b6f724c6-8832-4a19-9d24-6655326ad359",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "40b5fcd7-a5d2-4186-8205-e1fd1f0b2ef5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "468411af-11be-488a-b8a6-33f91c888a52",
"db_currency_id": "22e11863-7cf7-42dc-85e6-6d964df479dc",
"db_language_id": "a57e255d-00ec-48e1-a708-6b60b62416ec",
"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-19T10:35:44.3214387+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-19T10:35:44.3214387+00:00"
},
"project_status_id": "a23dce46-b617-47c4-bab9-98df71838484",
"project_status_code": "sample string 10",
"project_status": {
"id": "c41d5670-6fc9-4d33-8e26-c8310751c151",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "721abc7d-44a0-4bab-82bd-88d1209ac0dd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "40b5fcd7-a5d2-4186-8205-e1fd1f0b2ef5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "468411af-11be-488a-b8a6-33f91c888a52",
"db_currency_id": "22e11863-7cf7-42dc-85e6-6d964df479dc",
"db_language_id": "a57e255d-00ec-48e1-a708-6b60b62416ec",
"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-19T10:35:44.3214387+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-19T10:35:44.3214387+00:00"
},
"company_id": "338c51b4-4eb7-4a0c-b7ee-ca724ab24e35",
"company_code": "sample string 12",
"db_address_id": "63becf7a-7557-4f34-a970-b6eb55cfbd7f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d9023a43-d91f-4051-a900-654573dfbadf",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1ae388de-f3ec-4f9a-8411-42299e9fda0f",
"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-19T10:35:44.3214387+00:00",
"date_create": "2026-01-19T10:35:44.3214387+00:00",
"date_update": "2026-01-19T10:35:44.3214387+00:00",
"updated_by_user_id": "4a92921a-541f-4e10-8bee-7a6ce97c4082",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-19T10:35:44.3214387+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-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-19T10:35:44.3214387+00:00",
"date_last_job": "2026-01-19T10:35:44.3214387+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-19T10:35:44.3214387+00:00",
"modified_dateutc": "2026-01-19T10:35:44.3214387+00:00",
"is_mobile_installation": true
},
"job_type_id": "862628de-e0bd-487b-b94c-80e0fef65425",
"job_type_code": "sample string 7",
"job_type": {
"id": "804a4114-0e96-4824-a005-ef9d5a2ab7b2",
"name": "sample string 2",
"sales_organization_id": "4b77ac6c-a92a-4dc8-bb3e-a197b81784f9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-19T10:35:44.3214387+00:00",
"code": "sample string 7"
},
"job_priority_id": "91b18497-c0c8-4726-8870-5ac88fbe2629",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "68a86dc4-5ce1-4ca3-8951-e852ea348161",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3b271133-3820-4c68-bfde-de3a1796c435",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "40b5fcd7-a5d2-4186-8205-e1fd1f0b2ef5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "468411af-11be-488a-b8a6-33f91c888a52",
"db_currency_id": "22e11863-7cf7-42dc-85e6-6d964df479dc",
"db_language_id": "a57e255d-00ec-48e1-a708-6b60b62416ec",
"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-19T10:35:44.3214387+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-19T10:35:44.3214387+00:00"
},
"job_status_id": "b0c82811-5399-4397-8a80-41f97ebbfa15",
"job_status_code": "sample string 11",
"db_address_id": "f4570ce4-06f6-4936-aeaa-db34bd7bdab8",
"contact_id": "e99f3f7f-e28f-4ace-a6a0-eb478b9f5137",
"requested_by_company_id": "950a8fab-5245-4a24-ae37-e252c6f834c5",
"requested_by_contact_id": "d7fa7b61-b6e0-433f-8b54-e91aa83f659c",
"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-19T10:35:44.3214387+00:00",
"due_date": "2026-01-19T10:35:44.3214387+00:00",
"date_create": "2026-01-19T10:35:44.3214387+00:00",
"date_update": "2026-01-19T10:35:44.3214387+00:00",
"date_closed": "2026-01-19T10:35:44.3214387+00:00",
"suggested_user_id": "ef312b8c-bfef-4de4-82bd-03b762da7b61",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e5bdbf3d-7717-45c8-8c91-bc527514ff00",
"db_language_id": "93446a5f-c8b4-4e91-9bf2-46f2d24b5cab",
"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-19T10:35:44.3214387+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0fb029b6-0514-45e7-9992-8a46c0d0ecec",
"sales_organization": {
"id": "40b5fcd7-a5d2-4186-8205-e1fd1f0b2ef5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "468411af-11be-488a-b8a6-33f91c888a52",
"db_currency_id": "22e11863-7cf7-42dc-85e6-6d964df479dc",
"db_language_id": "a57e255d-00ec-48e1-a708-6b60b62416ec",
"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-19T10:35:44.3214387+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7b5099f1-1f97-44b5-9d61-e95428e861ab",
"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": "95d4a575-aeaf-417e-a2fd-f277adc74ea2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-19T10:35:44.3214387+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c5bd9e14-375b-4b88-b331-9ae15b79dfde"
},
"suggested_date_start": "2026-01-19T10:35:44.3214387+00:00",
"skill_id": "3cd38c49-a290-46f9-90b6-7dfd2ce5df9f",
"skill_code": "sample string 32",
"skill": {
"id": "15f87b8e-a18f-42ec-a029-16583c2770b9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3a215f77-a04e-45fe-a569-53ffbb2996ee",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "40b5fcd7-a5d2-4186-8205-e1fd1f0b2ef5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "468411af-11be-488a-b8a6-33f91c888a52",
"db_currency_id": "22e11863-7cf7-42dc-85e6-6d964df479dc",
"db_language_id": "a57e255d-00ec-48e1-a708-6b60b62416ec",
"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-19T10:35:44.3214387+00:00"
},
"modified_dateutc": "2026-01-19T10:35:44.3214387+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "16d4fe05-f361-4f32-a5a4-aaa792365572",
"date_reported_by_company": "2026-01-19T10:35:44.3214387+00:00",
"id2": 36,
"company_id": "6426f87a-f893-4695-83b2-767ac5a08d84",
"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": "3fa59d0c-d832-4fd0-8a43-9dd4d6f8cd94",
"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-19T10:35:44.3214387+00:00"
},
"work_instruction_details_id": "305ffff7-f83b-41d7-a6e0-c11e9704fc6a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "22463a15-22fb-489a-819e-378b31360836",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bf81bb4b-bee3-4773-aeff-0458c204383d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-19T10:35:44.3214387+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": "05c893df-b122-4473-abc5-1c8ed628bb8a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-19T10:35:44.3370654+00:00"
}